Click or drag to resize

FavoriteResources Interface

This interface provides methods to access Favorite resources.

Thread Safety: Implementation of this interface must be thread safe.

Namespace:  Smartsheet.Api
Assemblies:   smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
  smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
Syntax
Copy
public interface FavoriteResources

The FavoriteResources type exposes the following members.

Methods
  NameDescription
Public methodAddFavorites

Adds one or more items to the user’s list of Favorite items.

It mirrors to the following Smartsheet REST API method: POST /favorites

If called with a single Favorite object, and that favorite already exists, error code 1129 will be returned. If called with an array of Favorite objects, any objects specified in the array that are already marked as favorites will be ignored and omitted from the response.

Public methodListFavorites

Gets a list of all of the user’s Favorite items.

It mirrors to the following Smartsheet REST API method: GET /favorites

Remarks
This operation supports pagination of results. For more information, see Paging.
Public methodRemoveFavorites

Removes one or multiple objects from the user’s list of Favorite items.

It mirrors to the following Smartsheet REST API methods:

  • DELETE /favorites/folder
  • DELETE /favorites/report
  • DELETE /favorites/sheet
  • DELETE /favorites/template
  • DELETE /favorites/workspace

Top
See Also