C# Class Smartsheet.Api.Internal.SheetRowResourcesImpl

This is the implementation of the SheetRowResources. Thread Safety: This class is thread safe because it is immutable and its base class is thread safe.
Inheritance: AbstractResources, SheetRowResources
Show file Open project: smartsheet-platform/smartsheet-csharp-sdk Class Usage Examples

Public Methods

Method Description
AddRows ( long sheetId, IEnumerable rows ) : IList

Inserts one or more rows into the Sheet specified in the URL.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/rows

If multiple rows are specified in the request, all rows must be inserted at the same location (i.e. the toTop, toBottom, parentId, siblingId, and above attributes must be the same for all rows in the request).
AddRowsAllowPartialSuccess ( long sheetId, IEnumerable rows ) : BulkItemRowResult

Inserts one or more rows into the Sheet specified in the URL with allowPartialSuccess.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/rows?allowPartialSuccess=true

If multiple rows are specified in the request, all rows must be inserted at the same location (i.e. the toTop, toBottom, parentId, siblingId, and above attributes must be the same for all rows in the request).
CopyRowsToAnotherSheet ( long sheetId, CopyOrMoveRowDirective directive, IEnumerable include, bool ignoreRowsNotFound ) : CopyOrMoveRowResult

Copies Row(s) from the Sheet specified in the URL to (the bottom of) another sheet.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/copy

Up to 5,000 row IDs can be specified in the request, but if the total number of rows in the destination sheet after the copy exceeds the Smartsheet row limit, an error response will be returned.
DeleteRows ( long sheetId, IEnumerable ids, bool ignoreRowsNotFound ) : IList

Deletes one or more row(s) from the Sheet

It mirrors To the following Smartsheet REST API method: DELETE /sheets/{sheetId}/rows?ids={rowId1},{rowId2},{rowId3}...

This operation will delete ALL child Rows of the specified Row(s).
GetRow ( long sheetId, long rowId, IEnumerable include, IEnumerable exclude ) : Row

Gets the Row specified in the URL.

It mirrors To the following Smartsheet REST API method: GET /sheets/{sheetId}/rows/{rowId}
MoveRowsToAnotherSheet ( long sheetId, CopyOrMoveRowDirective directive, IEnumerable include, bool ignoreRowsNotFound ) : CopyOrMoveRowResult

Moves Row(s) from the Sheet specified in the URL to (the bottom of) another sheet.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/copy

Up to 5,000 row IDs can be specified in the request, but if the total number of rows in the destination sheet after the copy exceeds the Smartsheet row limit, an error response will be returned.

Any child rows of the rows specified in the request will also be moved. Parent-child relationships amongst rows will be preserved within the destination sheet.
SendRows ( long sheetId, MultiRowEmail email ) : void

Sends one or more Rows via email.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/emails
SheetRowResourcesImpl ( SmartsheetImpl smartsheet ) : System

Constructor. Parameters: - Smartsheet : the SmartsheetImpl Exceptions: - IllegalArgumentException : if any argument is null
UpdateRows ( long sheetId, IEnumerable rows ) : IList

Updates cell values in the specified row(s), expands/collapses the specified row(s), and/or modifies the position of specified rows (including indenting/outdenting).

It mirrors To the following Smartsheet REST API method: PUT /sheets/{sheetId}/rows

If a row’s position is updated, all child rows are moved with the row.
UpdateRowsAllowPartialSuccess ( long sheetId, IEnumerable rows ) : BulkItemRowResult

Updates cell values in the specified row(s), expands/collapses the specified row(s), and/or modifies the position of specified rows (including indenting/outdenting).

It mirrors To the following Smartsheet REST API method: PUT /sheets/{sheetId}/rows?allowPartialSuccess=true

If a row’s position is updated, all child rows are moved with the row.

Private Methods

Method Description
DeleteRow ( long sheetId, long rowId ) : void
SendRow ( long sheetId, long rowId, RowEmail email ) : void

Method Details

AddRows() public method

Inserts one or more rows into the Sheet specified in the URL.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/rows

If multiple rows are specified in the request, all rows must be inserted at the same location (i.e. the toTop, toBottom, parentId, siblingId, and above attributes must be the same for all rows in the request).
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 AddRows ( long sheetId, IEnumerable rows ) : IList
sheetId long the sheet Id
rows IEnumerable one or more rows
return IList

AddRowsAllowPartialSuccess() public method

Inserts one or more rows into the Sheet specified in the URL with allowPartialSuccess.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/rows?allowPartialSuccess=true

If multiple rows are specified in the request, all rows must be inserted at the same location (i.e. the toTop, toBottom, parentId, siblingId, and above attributes must be the same for all rows in the request).
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 AddRowsAllowPartialSuccess ( long sheetId, IEnumerable rows ) : BulkItemRowResult
sheetId long the sheet Id
rows IEnumerable one or more rows
return Smartsheet.Api.Models.BulkItemRowResult

CopyRowsToAnotherSheet() public method

Copies Row(s) from the Sheet specified in the URL to (the bottom of) another sheet.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/copy

Up to 5,000 row IDs can be specified in the request, but if the total number of rows in the destination sheet after the copy exceeds the Smartsheet row limit, an error response will be returned.
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 CopyRowsToAnotherSheet ( long sheetId, CopyOrMoveRowDirective directive, IEnumerable include, bool ignoreRowsNotFound ) : CopyOrMoveRowResult
sheetId long the sheet Id
directive Smartsheet.Api.Models.CopyOrMoveRowDirective directive
include IEnumerable objects to include
ignoreRowsNotFound bool ignoreRowsNotFound
return Smartsheet.Api.Models.CopyOrMoveRowResult

DeleteRows() public method

Deletes one or more row(s) from the Sheet

It mirrors To the following Smartsheet REST API method: DELETE /sheets/{sheetId}/rows?ids={rowId1},{rowId2},{rowId3}...

This operation will delete ALL child Rows of the specified Row(s).
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 DeleteRows ( long sheetId, IEnumerable ids, bool ignoreRowsNotFound ) : IList
sheetId long The sheet ID
ids IEnumerable The list of row IDs
ignoreRowsNotFound bool If set to false and any of the specified Row IDs are not found, no rows will be deleted, and the “not found” error will be returned.
return IList

GetRow() public method

Gets the Row specified in the URL.

It mirrors To the following Smartsheet REST API method: GET /sheets/{sheetId}/rows/{rowId}

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 GetRow ( long sheetId, long rowId, IEnumerable include, IEnumerable exclude ) : Row
sheetId long the sheetId
rowId long the rowId
include IEnumerable comma-separated list of elements to include in the response.
exclude IEnumerable a comma-separated list of optional objects to exclude in the response.
return Row

MoveRowsToAnotherSheet() public method

Moves Row(s) from the Sheet specified in the URL to (the bottom of) another sheet.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/copy

Up to 5,000 row IDs can be specified in the request, but if the total number of rows in the destination sheet after the copy exceeds the Smartsheet row limit, an error response will be returned.

Any child rows of the rows specified in the request will also be moved. Parent-child relationships amongst rows will be preserved within the destination sheet.
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 MoveRowsToAnotherSheet ( long sheetId, CopyOrMoveRowDirective directive, IEnumerable include, bool ignoreRowsNotFound ) : CopyOrMoveRowResult
sheetId long the sheet Id
directive Smartsheet.Api.Models.CopyOrMoveRowDirective directive
include IEnumerable the elements to include.
ignoreRowsNotFound bool ignoreRowsNotFound
return Smartsheet.Api.Models.CopyOrMoveRowResult

SendRows() public method

Sends one or more Rows via email.

It mirrors To the following Smartsheet REST API method: POST /sheets/{sheetId}/rows/emails

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 SendRows ( long sheetId, MultiRowEmail email ) : void
sheetId long The sheet Id
email Smartsheet.Api.Models.MultiRowEmail The email. The columns included for each row in the email will be populated according to the following rules: /// /// /// If the columnIds attribute of the MultiRowEmail object is specified as an array of column IDs, those specific columns will be included. /// /// /// If the columnIds attribute of the MultiRowEmail object is omitted, all columns except hidden columns shall be included. /// /// /// If the columnIds attribute of the MultiRowEmail object is specified as empty, no columns shall be included. /// (Note: In this case, either includeAttachments:true or includeDiscussions:true must be specified.) /// /// ///
return void

SheetRowResourcesImpl() public method

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

UpdateRows() public method

Updates cell values in the specified row(s), expands/collapses the specified row(s), and/or modifies the position of specified rows (including indenting/outdenting).

It mirrors To the following Smartsheet REST API method: PUT /sheets/{sheetId}/rows

If a row’s position is updated, all child rows are moved with the row.
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 UpdateRows ( long sheetId, IEnumerable rows ) : IList
sheetId long the sheetId
rows IEnumerable the list of rows to update
return IList

UpdateRowsAllowPartialSuccess() public method

Updates cell values in the specified row(s), expands/collapses the specified row(s), and/or modifies the position of specified rows (including indenting/outdenting).

It mirrors To the following Smartsheet REST API method: PUT /sheets/{sheetId}/rows?allowPartialSuccess=true

If a row’s position is updated, all child rows are moved with the row.
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 UpdateRowsAllowPartialSuccess ( long sheetId, IEnumerable rows ) : BulkItemRowResult
sheetId long the sheetId
rows IEnumerable the list of rows to update
return Smartsheet.Api.Models.BulkItemRowResult