@openim/client-sdk/lib/core/api/friend.d.ts

JavaScript/TypeScript Client SDK for OpenIM

import { ApiResponse, FriendUserItem, BlackUserItem, FriendApplicationItem, FriendshipInfo } from '../../types/entity';
import { MixinApiService } from '..';
import { AccessFriendParams, AddBlackParams, AddFriendParams, OffsetParams, UpdateFriendsParams } from '../../types/params';
export declare function setupFriend(apiService: MixinApiService): {
    addFriend: (params: AddFriendParams, operationID: string) => Promise<ApiResponse<any>>;
    checkFriend: (params: string[], operationID: string) => Promise<ApiResponse<any>>;
    deleteFriend: (params: string, operationID: string) => Promise<ApiResponse<any>>;
    acceptFriendApplication: (params: AccessFriendParams, operationID: string) => Promise<ApiResponse<any>>;
    refuseFriendApplication: (params: AccessFriendParams, operationID: string) => Promise<ApiResponse<any>>;
    getFriendListPage: (params: OffsetParams, operationID: string) => Promise<ApiResponse<any>>;
    getSpecifiedFriendsInfo: (params: string[], operationID: string) => Promise<ApiResponse<any>>;
    getFriendApplicationListAsApplicant: (params: OffsetParams, operationID: string) => Promise<ApiResponse<any>>;
    getFriendApplicationListAsRecipient: (params: OffsetParams, operationID: string) => Promise<ApiResponse<any>>;
    updateFriends: (params: UpdateFriendsParams, operationID: string) => Promise<ApiResponse<any>>;
    addBlack: (params: AddBlackParams, operationID: string) => Promise<ApiResponse<any>>;
    removeBlack: (params: string, operationID: string) => Promise<ApiResponse<any>>;
    getBlackList: (params: OffsetParams, operationID: string) => Promise<ApiResponse<any>>;
};
export interface FriendApi {
    addBlack: (params: AddBlackParams) => Promise<ApiResponse<unknown>>;
    addFriend: (params: AddFriendParams) => Promise<ApiResponse<unknown>>;
    checkFriend: (params: string[]) => Promise<ApiResponse<FriendshipInfo[]>>;
    deleteFriend: (params: string) => Promise<ApiResponse<unknown>>;
    getBlackList: (params: OffsetParams) => Promise<ApiResponse<BlackUserItem[]>>;
    getFriendApplicationListAsApplicant: (params: OffsetParams) => Promise<ApiResponse<FriendApplicationItem[]>>;
    getFriendApplicationListAsRecipient: (params: OffsetParams) => Promise<ApiResponse<FriendApplicationItem[]>>;
    acceptFriendApplication: (params: AccessFriendParams) => Promise<ApiResponse<unknown>>;
    getFriendListPage: (params: OffsetParams) => Promise<ApiResponse<FriendUserItem[]>>;
    getSpecifiedFriendsInfo: (params: string[]) => Promise<ApiResponse<FriendUserItem[]>>;
    refuseFriendApplication: (params: AccessFriendParams) => Promise<ApiResponse<unknown>>;
    removeBlack: (params: string) => Promise<ApiResponse<unknown>>;
    updateFriends: (params: UpdateFriendsParams) => Promise<ApiResponse<unknown>>;
}