Skip to content

Fix documentation for "at" parameter in members function #5490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
uhoreg wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Fix documentation for "at" parameter in members function #5490

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6907,15 +6907,15 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
/**
* @param includeMembership - the membership type to include in the response
* @param excludeMembership - the membership type to exclude from the response
* @param atEventId - the id of the event for which moment in the timeline the members should be returned for
* @param atSyncToken - the point in time, as a sync pagination token, for when the members should be returned for
* @returns Promise which resolves: dictionary of userid to profile information
* @returns Rejects: with an error response.
*/
public members(
roomId: string,
includeMembership?: string,
excludeMembership?: string,
atEventId?: string,
atSyncToken?: string,
): Promise<{ [userId: string]: IStateEventWithRoomId[] }> {
const queryParams: Record<string, string> = {};
if (includeMembership) {
Expand All @@ -6924,8 +6924,8 @@ export class MatrixClient extends TypedEventEmitter<EmittedEvents, ClientEventHa
if (excludeMembership) {
queryParams.not_membership = excludeMembership;
}
if (atEventId) {
queryParams.at = atEventId;
if (atSyncToken) {
queryParams.at = atSyncToken;
}

const queryString = utils.encodeParams(queryParams);
Expand Down
Loading