snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

packages/apps-engine/src/definition/accessors/IUserRead.ts

@@ -0,0 +1,31 @@
+import type { IUser } from '../users/index';
+
+/**
+ * This accessor provides methods for accessing
+ * users in a read-only-fashion.
+ */
+export interface IUserRead {
+	getById(id: string): Promise<IUser>;
+
+	getByUsername(username: string): Promise<IUser>;
+
+	getBySipExtension(extension: string): Promise<IUser | undefined>;
+
+	/**
+	 * Gets the app user of this app.
+	 */
+	getAppUser(appId?: string): Promise<IUser | undefined>;
+
+	/**
+	 * Gets the user's badge count (unread messages count).
+	 * @param uid user's id
+	 */
+	getUserUnreadMessageCount(uid: string): Promise<number | undefined>;
+
+	/**
+	 * Fetches the IDs of the rooms that the user is a member of.
+	 *
+	 * @param userId the user whose memberships should be returned
+	 */
+	getUserRoomIds(userId: string): Promise<string[]>;
+}