You've already forked matrix-js-sdk
mirror of
https://github.com/matrix-org/matrix-js-sdk.git
synced 2025-11-26 17:03:12 +03:00
add jsdocs
This commit is contained in:
@@ -438,7 +438,16 @@ MatrixBaseApis.prototype.createRoom = function(options, callback) {
|
|||||||
callback, "POST", "/createRoom", undefined, options,
|
callback, "POST", "/createRoom", undefined, options,
|
||||||
);
|
);
|
||||||
};
|
};
|
||||||
|
/**
|
||||||
|
* Fetches relations for a given event
|
||||||
|
* @param {string} roomId the room of the event
|
||||||
|
* @param {string} eventId the id of the event
|
||||||
|
* @param {string} relationType the rel_type of the relations requested
|
||||||
|
* @param {string} eventType the event type of the relations requested
|
||||||
|
* @param {Object} opts options with optional values for the request.
|
||||||
|
* @param {Object} opts.from the pagination token returned from a previous request as `next_batch` to return following relations.
|
||||||
|
* @return {Object} the response, with chunk and next_batch.
|
||||||
|
*/
|
||||||
MatrixBaseApis.prototype.fetchRelations =
|
MatrixBaseApis.prototype.fetchRelations =
|
||||||
async function(roomId, eventId, relationType, eventType, opts) {
|
async function(roomId, eventId, relationType, eventType, opts) {
|
||||||
const queryParams = {};
|
const queryParams = {};
|
||||||
|
|||||||
@@ -3965,6 +3965,16 @@ MatrixClient.prototype.getCanResetTimelineCallback = function() {
|
|||||||
return this._canResetTimelineCallback;
|
return this._canResetTimelineCallback;
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns relations for a given event
|
||||||
|
* @param {string} roomId the room of the event
|
||||||
|
* @param {string} eventId the id of the event
|
||||||
|
* @param {string} relationType the rel_type of the relations requested
|
||||||
|
* @param {string} eventType the event type of the relations requested
|
||||||
|
* @param {Object} opts options with optional values for the request.
|
||||||
|
* @param {Object} opts.from the pagination token returned from a previous request as `nextBatch` to return following relations.
|
||||||
|
* @return {Object} an object with `events` as `MatrixEvent[]` and optionally `nextBatch` if more relations are available.
|
||||||
|
*/
|
||||||
MatrixClient.prototype.relations =
|
MatrixClient.prototype.relations =
|
||||||
async function(roomId, eventId, relationType, eventType, opts = {}) {
|
async function(roomId, eventId, relationType, eventType, opts = {}) {
|
||||||
const result = await this.fetchRelations(
|
const result = await this.fetchRelations(
|
||||||
|
|||||||
Reference in New Issue
Block a user