@openim/protocol/lib/pb/relation/relation.d.ts

OpenIM protocol

import { type BlackInfo, type FriendInfo, type FriendRequest, type RequestPagination, type UserInfo } from "../sdkws/sdkws";
import { type BoolValue, type StringValue } from "../wrapperspb/wrapperspb";
export declare const protobufPackage = "openim.relation";
export interface getPaginationFriendsReq {
    pagination: RequestPagination | undefined;
    userID: string;
}
export interface getPaginationFriendsResp {
    friendsInfo: FriendInfo[];
    total: number;
}
export interface applyToAddFriendReq {
    fromUserID: string;
    toUserID: string;
    reqMsg: string;
    ex: string;
}
export interface applyToAddFriendResp {
}
export interface friendInfo {
    ownerUserID: string;
    friendUserID: string;
    friendNickname: string;
    friendFaceURL: string;
    remark: string;
    createTime: number;
    addSource: number;
    operatorUserID: string;
    ex: string;
    isPinned: boolean;
}
export interface importFriendReq {
    ownerUserID: string;
    friendUserIDs: string[];
}
export interface importFriendResp {
}
export interface getPaginationFriendsApplyToReq {
    userID: string;
    pagination: RequestPagination | undefined;
}
export interface getPaginationFriendsApplyToResp {
    FriendRequests: FriendRequest[];
    total: number;
}
export interface getDesignatedFriendsApplyReq {
    fromUserID: string;
    toUserID: string;
}
export interface getDesignatedFriendsApplyResp {
    friendRequests: FriendRequest[];
}
export interface getIncrementalFriendsApplyToReq {
    userID: string;
    versionID: string;
    version: number;
}
export interface getIncrementalFriendsApplyToResp {
    version: number;
    versionID: string;
    full: boolean;
    deleteUserIds: string[];
    changes: FriendRequest[];
}
export interface getIncrementalFriendsApplyFromReq {
    userID: string;
    versionID: string;
    version: number;
}
export interface getIncrementalFriendsApplyFromResp {
    version: number;
    versionID: string;
    full: boolean;
    deleteUserIds: string[];
    changes: FriendRequest[];
}
export interface getDesignatedFriendsReq {
    ownerUserID: string;
    friendUserIDs: string[];
}
export interface getDesignatedFriendsResp {
    friendsInfo: FriendInfo[];
}
export interface addBlackReq {
    ownerUserID: string;
    blackUserID: string;
    ex: string;
}
export interface addBlackResp {
}
export interface removeBlackReq {
    ownerUserID: string;
    blackUserID: string;
}
export interface removeBlackResp {
}
export interface getPaginationBlacksReq {
    userID: string;
    pagination: RequestPagination | undefined;
}
export interface getPaginationBlacksResp {
    blacks: BlackInfo[];
    total: number;
}
export interface isFriendReq {
    userID1: string;
    userID2: string;
}
export interface isFriendResp {
    /** If userID2 is in userID1’s friend list, return true */
    inUser1Friends: boolean;
    /** If userID1 is in userID2’s friend list, return true */
    inUser2Friends: boolean;
}
export interface isBlackReq {
    userID1: string;
    userID2: string;
}
export interface isBlackResp {
    /** If userID2 is in userID1's blacklist, true */
    inUser1Blacks: boolean;
    /** If userID1 is in userID2's blacklist, true */
    inUser2Blacks: boolean;
}
export interface deleteFriendReq {
    ownerUserID: string;
    friendUserID: string;
}
export interface deleteFriendResp {
}
/** process */
export interface respondFriendApplyReq {
    /** ID of the user initiating the friend request */
    fromUserID: string;
    /** ID of the user receiving the friend request */
    toUserID: string;
    handleResult: number;
    handleMsg: string;
}
export interface respondFriendApplyResp {
}
export interface updateFriendsReq {
    ownerUserID: string;
    friendUserIDs: string[];
    isPinned: BoolValue | undefined;
    remark: StringValue | undefined;
    ex: StringValue | undefined;
}
export interface updateFriendsResp {
}
export interface setFriendRemarkReq {
    ownerUserID: string;
    friendUserID: string;
    remark: string;
}
export interface setFriendRemarkResp {
}
export interface getPaginationFriendsApplyFromReq {
    userID: string;
    pagination: RequestPagination | undefined;
}
export interface getPaginationFriendsApplyFromResp {
    friendRequests: FriendRequest[];
    total: number;
}
export interface getFriendIDsReq {
    userID: string;
}
export interface getFriendIDsResp {
    friendIDs: string[];
}
export interface getSpecifiedFriendsInfoReq {
    ownerUserID: string;
    userIDList: string[];
}
export interface getSpecifiedFriendsInfoInfo {
    userInfo: UserInfo | undefined;
    friendInfo: FriendInfo | undefined;
    blackInfo: BlackInfo | undefined;
}
export interface getSpecifiedFriendsInfoResp {
    infos: getSpecifiedFriendsInfoInfo[];
}
export interface getIncrementalFriendsReq {
    userID: string;
    versionID: string;
    version: number;
}
export interface getIncrementalFriendsResp {
    version: number;
    versionID: string;
    full: boolean;
    delete: string[];
    insert: FriendInfo[];
    update: FriendInfo[];
    sortVersion: number;
}
export interface getIncrementalBlacksReq {
    userID: string;
    versionID: string;
    version: number;
}
export interface getIncrementalBlacksResp {
    version: number;
    versionID: string;
    full: boolean;
    delete: string[];
    insert: BlackInfo[];
    update: BlackInfo[];
}
export interface GetSpecifiedBlacksReq {
    ownerUserID: string;
    userIDList: string[];
}
export interface GetSpecifiedBlacksResp {
    blacks: BlackInfo[];
    total: number;
}
export interface getFullFriendUserIDsReq {
    idHash: number;
    userID: string;
}
export interface getFullFriendUserIDsResp {
    version: number;
    versionID: string;
    equal: boolean;
    userIDs: string[];
}
export interface notificationUserInfoUpdateReq {
    userID: string;
    oldUserInfo: UserInfo | undefined;
    newUserInfo: UserInfo | undefined;
}
export interface notificationUserInfoUpdateResp {
}
export interface FriendInfoOnly {
    ownerUserID: string;
    friendUserID: string;
    remark: string;
    createTime: number;
    addSource: number;
    operatorUserID: string;
    ex: string;
    isPinned: boolean;
}
export interface getFriendInfoReq {
    ownerUserID: string;
    friendUserIDs: string[];
}
export interface getFriendInfoResp {
    friendInfos: FriendInfoOnly[];
}
export interface friend {
    /** Friend request */
    applyToAddFriend(request: applyToAddFriendReq): Promise<applyToAddFriendResp>;
    /** Get friend request list */
    getPaginationFriendsApplyTo(request: getPaginationFriendsApplyToReq): Promise<getPaginationFriendsApplyToResp>;
    /** Get sent friend request list */
    getPaginationFriendsApplyFrom(request: getPaginationFriendsApplyFromReq): Promise<getPaginationFriendsApplyFromResp>;
    /** Get specified friend request */
    getDesignatedFriendsApply(request: getDesignatedFriendsApplyReq): Promise<getDesignatedFriendsApplyResp>;
    /** Get Incremental friends apply to list */
    getIncrementalFriendsApplyTo(request: getIncrementalFriendsApplyToReq): Promise<getIncrementalFriendsApplyToResp>;
    /** Get Incremental friends apply from list */
    getIncrementalFriendsApplyFrom(request: getIncrementalFriendsApplyFromReq): Promise<getIncrementalFriendsApplyFromResp>;
    /** Add black user */
    addBlack(request: addBlackReq): Promise<addBlackResp>;
    /** Remove black user */
    removeBlack(request: removeBlackReq): Promise<removeBlackResp>;
    /** Check user is in friends list */
    isFriend(request: isFriendReq): Promise<isFriendResp>;
    /** Check user is blacklist */
    isBlack(request: isBlackReq): Promise<isBlackResp>;
    /** Get blacklist */
    getPaginationBlacks(request: getPaginationBlacksReq): Promise<getPaginationBlacksResp>;
    /** Get specified blacklist */
    GetSpecifiedBlacks(request: GetSpecifiedBlacksReq): Promise<GetSpecifiedBlacksResp>;
    /** Delete friend */
    deleteFriend(request: deleteFriendReq): Promise<deleteFriendResp>;
    /** Respond to friend request (Accept or Decline) */
    respondFriendApply(request: respondFriendApplyReq): Promise<respondFriendApplyResp>;
    /** Favorited friend */
    updateFriends(request: updateFriendsReq): Promise<updateFriendsResp>;
    /** Set friend nickname */
    setFriendRemark(request: setFriendRemarkReq): Promise<setFriendRemarkResp>;
    /** Import friends relationship */
    importFriends(request: importFriendReq): Promise<importFriendResp>;
    /** Paginate and retrieve friend list; do not return error if no results. */
    getDesignatedFriends(request: getDesignatedFriendsReq): Promise<getDesignatedFriendsResp>;
    /** Get specified friend's information; return error if ID does not exist. */
    getPaginationFriends(request: getPaginationFriendsReq): Promise<getPaginationFriendsResp>;
    /** Get friend IDs list */
    getFriendIDs(request: getFriendIDsReq): Promise<getFriendIDsResp>;
    /** Get specified friends info */
    GetSpecifiedFriendsInfo(request: getSpecifiedFriendsInfoReq): Promise<getSpecifiedFriendsInfoResp>;
    getIncrementalFriends(request: getIncrementalFriendsReq): Promise<getIncrementalFriendsResp>;
    /** Get Incremental blackslist */
    getIncrementalBlacks(request: getIncrementalBlacksReq): Promise<getIncrementalBlacksResp>;
    /** Get full friend userIDs */
    getFullFriendUserIDs(request: getFullFriendUserIDsReq): Promise<getFullFriendUserIDsResp>;
    NotificationUserInfoUpdate(request: notificationUserInfoUpdateReq): Promise<notificationUserInfoUpdateResp>;
    getFriendInfo(request: getFriendInfoReq): Promise<getFriendInfoResp>;
}