@univerjs-pro/collaboration-client 0.4.1-nightly.202410241606 → 0.4.1-nightly.202410261605

package/lib/types/index.d.ts

@@ -31,3 +31,4 @@ export { SnapshotServerOverHTTPService } from './services/snapshot-server/snapsh
 export { CommentService } from './services/comment/comment.service';
 export { type ISheetCollabCursorShapeProps, SheetCollabCursorShape } from './views/shapes/sheet-collab-cursor.shape';
 export { ImageIoService } from './services/image-remote/image-io.service';
+export { MemberService } from './services/member/member.service';

package/lib/types/services/member/member.service.d.ts

@@ -19,9 +19,30 @@ export declare class MemberService extends Disposable {
      * @deprecated please use userManagerService
      */
     getCurrentUser(): Nullable<IUser>;
+    /**
+     * Update a member in a room(unit).
+     * @param roomID i.e. unitID.
+     * @param member member object to be updated.
+     */
     updateMember(roomID: string, member: IMember): void;
+    /**
+     * Remove a member from a room(unit).
+     * @param roomID i.e. unitID.
+     * @param memberID memberID of the member to be removed.
+     */
     removeMember(roomID: string, memberID: string): void;
+    /**
+     * Get RoomMember for a unit.
+     * @param roomID which is same with unitId.
+     * @returns RoomMember which is a object that manages members in a single room.
+     */
     getRoom(roomID: string): RoomMember | undefined;
+    /**
+     * Get a member in a room(unit).
+     * @param roomID i.e. unitID.
+     * @param memberID memberID of the member to be retrieved.
+     * @returns member object.
+     */
     getMember(roomID: string, memberID: string): IMember | undefined;
     private _removeRoom;
     dispose(): void;
@@ -32,7 +53,25 @@ export declare class MemberService extends Disposable {
 export declare class RoomMember extends Disposable {
     private readonly _members;
     dispose(): void;
+    /**
+     * Update a member in the room(unit).
+     * @param member member object to be updated.
+     */
     updateMember(member: IMember): void;
+    /**
+     * Remove a member from the room(unit).
+     * @param memberID memberID of the member to be removed.
+     */
     removeMember(memberID: string): void;
+    /**
+     * Get a member by memberID.
+     * @param memberID
+     * @returns member object.
+     */
     getMember(memberID: string): IMember | undefined;
+    /**
+     * Get all members in the room(unit).
+     * @returns member object array.
+     */
+    getAllMembers(): IMember[];
 }