C# Class Smartsheet.Api.Internal.SheetUpdateRequestResourcesImpl

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

Public Methods

Method Description
CreateUpdateRequest ( long sheetId, UpdateRequest updateRequest ) : UpdateRequest

Creates an Update Request for the specified Row(s) within the Sheet. An email notification (containing a link to the update request) will be asynchronously sent to the specified recipient(s).

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

DeleteSentUpdateRequest ( long sheetId, long sentUupdateRequestId ) : void

Deletes the specified sent update request.

It mirrors To the following Smartsheet REST API method: DELETE /sheets/{sheetId}/sentupdaterequests/{sentUpdateRequestId}

DeleteUpdateRequest ( long sheetId, long updateRequestId ) : void

Terminates the future scheduled delivery of the Update Request specified in the URL.

It mirrors To the following Smartsheet REST API method: DELETE /sheets/{sheetId}/updaterequests/{updateRequestId}

GetSentUpdateRequest ( long sheetId, long sentUpdateRequestId ) : SentUpdateRequest

Gets the specified sent update request on the Sheet.

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

GetUpdateRequest ( long sheetId, long updateRequestId ) : UpdateRequest

Gets the specified Update Request for the Sheet that has a future schedule.

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

ListSentUpdateRequests ( long sheetId, PaginationParameters paging ) : PaginatedResult

Gets a list of all Sent Update Requests that have future schedules associated with the specified Sheet.

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

ListUpdateRequests ( long sheetId, PaginationParameters paging ) : PaginatedResult

Gets a list of all Update Requests that have future schedules associated with the specified Sheet.

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

SheetUpdateRequestResourcesImpl ( SmartsheetImpl smartsheet ) : System.Collections.Generic
UpdateUpdateRequest ( long sheetId, UpdateRequest updateRequest ) : UpdateRequest

Changes the specified Update Request for the Sheet.

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

Method Details

CreateUpdateRequest() public method

Creates an Update Request for the specified Row(s) within the Sheet. An email notification (containing a link to the update request) will be asynchronously sent to the specified recipient(s).

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

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 CreateUpdateRequest ( long sheetId, UpdateRequest updateRequest ) : UpdateRequest
sheetId long the sheetId
updateRequest Smartsheet.Api.Models.UpdateRequest
return Smartsheet.Api.Models.UpdateRequest

DeleteSentUpdateRequest() public method

Deletes the specified sent update request.

It mirrors To the following Smartsheet REST API method: DELETE /sheets/{sheetId}/sentupdaterequests/{sentUpdateRequestId}

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 DeleteSentUpdateRequest ( long sheetId, long sentUupdateRequestId ) : void
sheetId long the Id of the sheet
sentUupdateRequestId long
return void

DeleteUpdateRequest() public method

Terminates the future scheduled delivery of the Update Request specified in the URL.

It mirrors To the following Smartsheet REST API method: DELETE /sheets/{sheetId}/updaterequests/{updateRequestId}

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 DeleteUpdateRequest ( long sheetId, long updateRequestId ) : void
sheetId long the sheetId
updateRequestId long the updateRequestId
return void

GetSentUpdateRequest() public method

Gets the specified sent update request on the Sheet.

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

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 GetSentUpdateRequest ( long sheetId, long sentUpdateRequestId ) : SentUpdateRequest
sheetId long the Id of the sheet
sentUpdateRequestId long the sent update request Id
return Smartsheet.Api.Models.SentUpdateRequest

GetUpdateRequest() public method

Gets the specified Update Request for the Sheet that has a future schedule.

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

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 GetUpdateRequest ( long sheetId, long updateRequestId ) : UpdateRequest
sheetId long the Id of the sheet
updateRequestId long the update request Id
return Smartsheet.Api.Models.UpdateRequest

ListSentUpdateRequests() public method

Gets a list of all Sent Update Requests that have future schedules associated with the specified Sheet.

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

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 ListSentUpdateRequests ( long sheetId, PaginationParameters paging ) : PaginatedResult
sheetId long the Id of the sheet
paging Smartsheet.Api.Models.PaginationParameters paging parameters for the list
return PaginatedResult

ListUpdateRequests() public method

Gets a list of all Update Requests that have future schedules associated with the specified Sheet.

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

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 ListUpdateRequests ( long sheetId, PaginationParameters paging ) : PaginatedResult
sheetId long
paging Smartsheet.Api.Models.PaginationParameters
return PaginatedResult

SheetUpdateRequestResourcesImpl() public method

public SheetUpdateRequestResourcesImpl ( SmartsheetImpl smartsheet ) : System.Collections.Generic
smartsheet SmartsheetImpl
return System.Collections.Generic

UpdateUpdateRequest() public method

Changes the specified Update Request for the Sheet.

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

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 UpdateUpdateRequest ( long sheetId, UpdateRequest updateRequest ) : UpdateRequest
sheetId long the sheet Id
updateRequest Smartsheet.Api.Models.UpdateRequest the UpdateRequest to update
return Smartsheet.Api.Models.UpdateRequest