Class MatrixHttpApi<O>

Type Parameters

O extends IHttpOpts

Hierarchy

FetchHttpApi<O>
- MatrixHttpApi

Index

Constructors

constructor

new MatrixHttpApi<O>(eventEmitter: TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap, HttpApiEventHandlerMap>, opts: O): MatrixHttpApi<O>
Type Parameters
- O extends IHttpOpts
Parameters
- eventEmitter: TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap, HttpApiEventHandlerMap>
- opts: O
Returns MatrixHttpApi<O>
Inherited from FetchHttpApi.constructor
- Defined in src/http-api/fetch.ts:44

Properties

`Readonly` opts

opts: O

`Private` uploads

uploads: Upload[] = []

Methods

abort

abort(): void
Returns void
Inherited from FetchHttpApi.abort
- Defined in src/http-api/fetch.ts:53

authedRequest

authedRequest<T>(method: Method, path: string, queryParams?: QueryDict, body?: Body, opts?: IRequestOpts): Promise<ResponseType<T, O>>
Perform an authorised request to the homeserver.

Returns
Resolves to {data: {Object}, headers: {Object}, code: {Number}}. If onlyData is set, this will resolve to the data object only.

Returns
Rejects with an error if a problem occurred. This includes network problems and Matrix-specific error JSON.
Type Parameters
- T
Parameters
- method: Method
  
  The HTTP method e.g. "GET".
- path: string
  
  The HTTP path after the supplied prefix e.g. "/createRoom".
- Optional queryParams: QueryDict
  
  A dict of query params (these will NOT be urlencoded). If unspecified, there will be no query params.
- Optional body: Body
  
  The HTTP JSON body.
- opts: IRequestOpts = {}
  
  additional options. If a number is specified, this is treated as opts.localTimeoutMs.
Returns Promise<ResponseType<T, O>>
Inherited from FetchHttpApi.authedRequest
- Defined in src/http-api/fetch.ts:137

cancelUpload

cancelUpload(promise: Promise<UploadResponse>): boolean
Parameters
- promise: Promise<UploadResponse>
Returns boolean
- Defined in src/http-api/index.ts:178

fetch

fetch(resource: string | URL, options?: RequestInit): Promise<Response>
Parameters
- resource: string | URL
- Optional options: RequestInit
Returns Promise<Response>
Inherited from FetchHttpApi.fetch
- Defined in src/http-api/fetch.ts:58

getContentUri

getContentUri(): IContentUri
Get the content repository url with query parameters.

Returns
An object with a 'base', 'path' and 'params' for base URL, path and query parameters respectively.

Returns IContentUri
- Defined in src/http-api/index.ts:196

getCurrentUploads

getCurrentUploads(): Upload[]
Returns Upload[]
- Defined in src/http-api/index.ts:187

getUrl

getUrl(path: string, queryParams?: QueryDict, prefix?: string, baseUrl?: string): URL
Form and return a homeserver request URL based on the given path params and prefix.

Returns
URL
Parameters
- path: string
  
  The HTTP path after the supplied prefix e.g. "/createRoom".
- Optional queryParams: QueryDict
  
  A dict of query params (these will NOT be urlencoded).
- Optional prefix: string
  
  The full prefix to use e.g. "/_matrix/client/v2_alpha", defaulting to this.opts.prefix.
- Optional baseUrl: string
  
  The baseUrl to use e.g. "https://matrix.org/", defaulting to this.opts.baseUrl.
Returns URL
Inherited from FetchHttpApi.getUrl
- Defined in src/http-api/fetch.ts:319

idServerRequest

idServerRequest<T>(method: Method, path: string, params: undefined | Record<string, string | string[]>, prefix: string, accessToken?: string): Promise<ResponseType<T, O>>
Type Parameters
- T extends {}
Parameters
- method: Method
- path: string
- params: undefined | Record<string, string | string[]>
- prefix: string
- Optional accessToken: string
Returns Promise<ResponseType<T, O>>
Inherited from FetchHttpApi.idServerRequest
- Defined in src/http-api/fetch.ts:73

request

request<T>(method: Method, path: string, queryParams?: QueryDict, body?: Body, opts?: IRequestOpts): Promise<ResponseType<T, O>>
Perform a request to the homeserver without any credentials.

Returns
Resolves to {data: {Object}, headers: {Object}, code: {Number}}. If onlyData is set, this will resolve to the data object only.

Returns
Rejects with an error if a problem occurred. This includes network problems and Matrix-specific error JSON.
Type Parameters
- T
Parameters
- method: Method
  
  The HTTP method e.g. "GET".
- path: string
  
  The HTTP path after the supplied prefix e.g. "/createRoom".
- Optional queryParams: QueryDict
  
  A dict of query params (these will NOT be urlencoded). If unspecified, there will be no query params.
- Optional body: Body
  
  The HTTP JSON body.
- Optional opts: IRequestOpts
  
  additional options
Returns Promise<ResponseType<T, O>>
Inherited from FetchHttpApi.request
- Defined in src/http-api/fetch.ts:205

requestOtherUrl

requestOtherUrl<T>(method: Method, url: string | URL, body?: Body, opts?: Pick<IRequestOpts, "json" | "headers" | "localTimeoutMs" | "keepAlive" | "abortSignal">): Promise<ResponseType<T, O>>
Perform a request to an arbitrary URL.

Returns
Resolves to data unless onlyData is specified as false, where the resolved value will be a fetch Response object.

Returns
Rejects with an error if a problem occurred. This includes network problems and Matrix-specific error JSON.
Type Parameters
- T
Parameters
- method: Method
  
  The HTTP method e.g. "GET".
- url: string | URL
  
  The HTTP URL object.
- Optional body: Body
  
  The HTTP JSON body.
- opts: Pick<IRequestOpts, "json" | "headers" | "localTimeoutMs" | "keepAlive" | "abortSignal"> = {}
  
  additional options
Returns Promise<ResponseType<T, O>>
Inherited from FetchHttpApi.requestOtherUrl
- Defined in src/http-api/fetch.ts:235

setIdBaseUrl

setIdBaseUrl(url: string): void
Sets the base URL for the identity server
Parameters
- url: string
  
  The new base url
Returns void
Inherited from FetchHttpApi.setIdBaseUrl
- Defined in src/http-api/fetch.ts:69

uploadContent

uploadContent(file: XMLHttpRequestBodyInit, opts?: UploadOpts): Promise<UploadResponse>
Upload content to the homeserver

Returns
Resolves to response object, as determined by this.opts.onlyData, opts.rawResponse, and opts.onlyContentUri. Rejects with an error (usually a MatrixError).
Parameters
- file: XMLHttpRequestBodyInit
  
  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.
- opts: UploadOpts = {}
  
  options object
Returns Promise<UploadResponse>
- Defined in src/http-api/index.ts:62

Class MatrixHttpApi<O>

Type Parameters

O extends IHttpOpts

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

O extends IHttpOpts

Parameters

eventEmitter: TypedEventEmitter<HttpApiEvent, HttpApiEventHandlerMap, HttpApiEventHandlerMap>

opts: O

Returns MatrixHttpApi<O>

Properties

Readonly opts

Private uploads

Methods

abort

Returns void

authedRequest

Returns

Returns

Type Parameters

T

Parameters

method: Method

path: string

Optional queryParams: QueryDict

Optional body: Body

opts: IRequestOpts = {}

Returns Promise<ResponseType<T, O>>

cancelUpload

Parameters

promise: Promise<UploadResponse>

Returns boolean

fetch

Parameters

resource: string | URL

Optional options: RequestInit

Returns Promise<Response>

getContentUri

Returns

Returns IContentUri

getCurrentUploads

Returns Upload[]

getUrl

Returns

Parameters

path: string

Optional queryParams: QueryDict

Optional prefix: string

Optional baseUrl: string

Returns URL

idServerRequest

Type Parameters

T extends {}

Parameters

method: Method

path: string

params: undefined | Record<string, string | string[]>

prefix: string

Optional accessToken: string

Returns Promise<ResponseType<T, O>>

request

Returns

Returns

Type Parameters

T

Parameters

method: Method

path: string

Optional queryParams: QueryDict

Optional body: Body

Optional opts: IRequestOpts

Returns Promise<ResponseType<T, O>>

requestOtherUrl

Returns

`Readonly` opts

`Private` uploads

`Optional` queryParams: QueryDict

`Optional` body: Body

`Optional` options: RequestInit

`Optional` queryParams: QueryDict

`Optional` prefix: string

`Optional` baseUrl: string

`Optional` accessToken: string

`Optional` queryParams: QueryDict

`Optional` body: Body

`Optional` opts: IRequestOpts

`Optional` body: Body