You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
50 lines
2.9 KiB
50 lines
2.9 KiB
// Copyright © 2023 OpenIM. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package database
|
|
|
|
import (
|
|
"context"
|
|
"github.com/openimsdk/open-im-server/v3/pkg/common/storage/model"
|
|
"github.com/openimsdk/tools/db/pagination"
|
|
)
|
|
|
|
// Friend defines the operations for managing friends in MongoDB.
|
|
type Friend interface {
|
|
// Create inserts multiple friend records.
|
|
Create(ctx context.Context, friends []*model.Friend) (err error)
|
|
// Delete removes specified friends of the owner user.
|
|
Delete(ctx context.Context, ownerUserID string, friendUserIDs []string) (err error)
|
|
// UpdateByMap updates specific fields of a friend document using a map.
|
|
UpdateByMap(ctx context.Context, ownerUserID string, friendUserID string, args map[string]any) (err error)
|
|
// UpdateRemark modify remarks.
|
|
UpdateRemark(ctx context.Context, ownerUserID, friendUserID, remark string) (err error)
|
|
// Take retrieves a single friend document. Returns an error if not found.
|
|
Take(ctx context.Context, ownerUserID, friendUserID string) (friend *model.Friend, err error)
|
|
// FindUserState finds the friendship status between two users.
|
|
FindUserState(ctx context.Context, userID1, userID2 string) (friends []*model.Friend, err error)
|
|
// FindFriends retrieves a list of friends for a given owner. Missing friends do not cause an error.
|
|
FindFriends(ctx context.Context, ownerUserID string, friendUserIDs []string) (friends []*model.Friend, err error)
|
|
// FindReversalFriends finds users who have added the specified user as a friend.
|
|
FindReversalFriends(ctx context.Context, friendUserID string, ownerUserIDs []string) (friends []*model.Friend, err error)
|
|
// FindOwnerFriends retrieves a paginated list of friends for a given owner.
|
|
FindOwnerFriends(ctx context.Context, ownerUserID string, pagination pagination.Pagination) (total int64, friends []*model.Friend, err error)
|
|
// FindInWhoseFriends finds users who have added the specified user as a friend, with pagination.
|
|
FindInWhoseFriends(ctx context.Context, friendUserID string, pagination pagination.Pagination) (total int64, friends []*model.Friend, err error)
|
|
// FindFriendUserIDs retrieves a list of friend user IDs for a given owner.
|
|
FindFriendUserIDs(ctx context.Context, ownerUserID string) (friendUserIDs []string, err error)
|
|
// UpdateFriends update friends' fields
|
|
UpdateFriends(ctx context.Context, ownerUserID string, friendUserIDs []string, val map[string]any) (err error)
|
|
}
|