C# 클래스 Smartsheet.Api.Internal.FavoriteResourcesImpl

This is the implementation of the FavoriteResources. Thread Safety: This class is thread safe because it is immutable and its base class is thread safe.
상속: AbstractResources, FavoriteResources
파일 보기 프로젝트 열기: smartsheet-platform/smartsheet-csharp-sdk 1 사용 예제들

공개 메소드들

메소드 설명
AddFavorites ( IEnumerable favorites ) : IList

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.
FavoriteResourcesImpl ( SmartsheetImpl smartsheet ) : System

Constructor. Exceptions: - IllegalArgumentException : if any argument is null
ListFavorites ( PaginationParameters paging ) : PaginatedResult

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

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

This operation supports pagination of results. For more information, see Paging.
RemoveFavorites ( ObjectType type, IList objectIds ) : void

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

objectIds must not be null or empty.

It mirrors To the following Smartsheet REST API methods: DELETE /favorites/folder DELETE /favorites/report DELETE /favorites/sheet DELETE /favorites/sight DELETE /favorites/template DELETE /favorites/workspace

메소드 상세

AddFavorites() 공개 메소드

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.

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public AddFavorites ( IEnumerable favorites ) : IList
favorites IEnumerable list of favorite objects
리턴 IList

FavoriteResourcesImpl() 공개 메소드

Constructor. Exceptions: - IllegalArgumentException : if any argument is null
public FavoriteResourcesImpl ( SmartsheetImpl smartsheet ) : System
smartsheet SmartsheetImpl the Smartsheet
리턴 System

ListFavorites() 공개 메소드

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

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

This operation supports pagination of results. For more information, see Paging.
if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public ListFavorites ( PaginationParameters paging ) : PaginatedResult
paging Smartsheet.Api.Models.PaginationParameters the pagination
리턴 PaginatedResult

RemoveFavorites() 공개 메소드

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

objectIds must not be null or empty.

It mirrors To the following Smartsheet REST API methods: DELETE /favorites/folder DELETE /favorites/report DELETE /favorites/sheet DELETE /favorites/sight DELETE /favorites/template DELETE /favorites/workspace

if any argument is null or empty string if there is any problem with the REST API request if there is any problem with the REST API authorization (access token) if the resource cannot be found if the REST API service is not available (possibly due To rate limiting) if there is any other error during the operation
public RemoveFavorites ( ObjectType type, IList objectIds ) : void
type ObjectType the object type to remove
objectIds IList (required): a comma-separated list of object IDs representing the items to remove from Favorites
리턴 void