github.com/cs3org/reva/v2@v2.27.7/pkg/storage/favorite/favorite.go (about)

     1  // Copyright 2018-2021 CERN
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  //
    15  // In applying this license, CERN does not waive the privileges and immunities
    16  // granted to it by virtue of its status as an Intergovernmental Organization
    17  // or submit itself to any jurisdiction.
    18  
    19  package favorite
    20  
    21  import (
    22  	"context"
    23  
    24  	user "github.com/cs3org/go-cs3apis/cs3/identity/user/v1beta1"
    25  	provider "github.com/cs3org/go-cs3apis/cs3/storage/provider/v1beta1"
    26  )
    27  
    28  // Manager defines an interface for a favorites manager.
    29  type Manager interface {
    30  	// ListFavorites returns all resources that were favorited by a user.
    31  	ListFavorites(ctx context.Context, userID *user.UserId) ([]*provider.ResourceId, error)
    32  	// SetFavorite marks a resource as favorited by a user.
    33  	SetFavorite(ctx context.Context, userID *user.UserId, resourceInfo *provider.ResourceInfo) error
    34  	// UnsetFavorite unmarks a resource as favorited by a user.
    35  	UnsetFavorite(ctx context.Context, userID *user.UserId, resourceInfo *provider.ResourceInfo) error
    36  }