C# Class Smartsheet.Api.Internal.SightResourcesImpl

Inheritance: AbstractResources, SightResources
Show file Open project: smartsheet-platform/smartsheet-csharp-sdk

Public Methods

Method Description
CopySight ( long sightId, ContainerDestination destination ) : Sight

Creates a copy of the specified Sight.

It mirrors To the following Smartsheet REST API method:
POST /sights/{sightId}/copy
DeleteSight ( long sightId ) : void

Delete a sight.

It mirrors To the following Smartsheet REST API method: DELETE /sights/{sightId}
GetSight ( long sightId ) : Sight

Get a specified Sight.

It mirrors To the following Smartsheet REST API method: GET /sights/{sightId}
ListSights ( PaginationParameters paging, System.DateTime modifiedSince ) : PaginatedResult

Gets the list of all Sights that the User has access to.

It mirrors To the following Smartsheet REST API method: GET /sights
MoveSight ( long sightId, ContainerDestination destination ) : Sight

Moves the specified Sight to a new location.

It mirrors To the following Smartsheet REST API method:
POST /sights/{sightId}/move
SightResourcesImpl ( SmartsheetImpl smartsheet ) : System

Constructor. Exceptions: - IllegalArgumentException : if any argument is null
UpdateSight ( Sight sight ) : Sight

Updates (renames) the specified Sight.

The request body is limited to the name attribute.

It mirrors To the following Smartsheet REST API method: PUT /sights/{sightId}

Method Details

CopySight() public method

Creates a copy of the specified Sight.

It mirrors To the following Smartsheet REST API method:
POST /sights/{sightId}/copy

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 CopySight ( long sightId, ContainerDestination destination ) : Sight
sightId long the sightId
destination Smartsheet.Api.Models.ContainerDestination the destination to copy to
return Smartsheet.Api.Models.Sight

DeleteSight() public method

Delete a sight.

It mirrors To the following Smartsheet REST API method: DELETE /sights/{sightId}

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 DeleteSight ( long sightId ) : void
sightId long the sightId
return void

GetSight() public method

Get a specified Sight.

It mirrors To the following Smartsheet REST API method: GET /sights/{sightId}

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 GetSight ( long sightId ) : Sight
sightId long the Id of the sight
return Smartsheet.Api.Models.Sight

ListSights() public method

Gets the list of all Sights that the User has access to.

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

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 ListSights ( PaginationParameters paging, System.DateTime modifiedSince ) : PaginatedResult
paging Smartsheet.Api.Models.PaginationParameters
modifiedSince System.DateTime
return PaginatedResult

MoveSight() public method

Moves the specified Sight to a new location.

It mirrors To the following Smartsheet REST API method:
POST /sights/{sightId}/move

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 MoveSight ( long sightId, ContainerDestination destination ) : Sight
sightId long the sightId
destination Smartsheet.Api.Models.ContainerDestination the destination to copy to
return Smartsheet.Api.Models.Sight

SightResourcesImpl() public method

Constructor. Exceptions: - IllegalArgumentException : if any argument is null
public SightResourcesImpl ( SmartsheetImpl smartsheet ) : System
smartsheet SmartsheetImpl the Smartsheet
return System

UpdateSight() public method

Updates (renames) the specified Sight.

The request body is limited to the name attribute.

It mirrors To the following Smartsheet REST API method: PUT /sights/{sightId}

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 UpdateSight ( Sight sight ) : Sight
sight Smartsheet.Api.Models.Sight the sight To update
return Smartsheet.Api.Models.Sight