C# Class Smartsheet.Api.Internal.GroupResourcesImpl

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

Public Methods

Method Description
AddGroupMembers ( long groupId, IEnumerable groupMembers ) : IList

Adds one or more members to a Group.

If called with a single GroupMember object, and that group member already exists, error code 1129 will be returned. If called with an array of GroupMember objects any users specified in the array that are already group members will be ignored and omitted from the response.

This operation is only available to group administrators and system administrators.

This operation is asynchronous, meaning the users may not yet have sharing access to sheets for a period of time after this operation returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete.

It mirrors To the following Smartsheet REST API method: POST /groups/{groupId}/members
CreateGroup ( Group group ) : Group

Creates a new Group.

It mirrors To the following Smartsheet REST API method: POST /groups

This operation is only available to group administrators and system administrators.
DeleteGroup ( long groupId ) : void

Deletes the Group specified in the URL.

This operation is only available to system administrators.

It mirrors To the following Smartsheet REST API method: DELETE /groups/{groupId}
GetGroup ( long groupId ) : Group

Gets the Group specified in the URL.

It mirrors To the following Smartsheet REST API method: GET /groups/{groupId}
GroupResourcesImpl ( SmartsheetImpl smartsheet ) : System.Collections.Generic

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

List all Users.

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

This operation supports pagination of results. For more information, see Paging.
RemoveGroupMember ( long groupId, long userId ) : void

Removes a member from a Group.

This operation is only available to group administrators and system administrators.

This operation is asynchronous, meaning group members may retain their sharing access for a brief period of time after the call returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete.

It mirrors To the following Smartsheet REST API method: DELETE /groups/{groupId}/members/{userId}
UpdateGroup ( Group group ) : Group

Updates the Group specified in the URL.

It mirrors To the following Smartsheet REST API method: PUT /groups/{groupId}

This operation is only available to group administrators and system administrators.

Method Details

AddGroupMembers() public method

Adds one or more members to a Group.

If called with a single GroupMember object, and that group member already exists, error code 1129 will be returned. If called with an array of GroupMember objects any users specified in the array that are already group members will be ignored and omitted from the response.

This operation is only available to group administrators and system administrators.

This operation is asynchronous, meaning the users may not yet have sharing access to sheets for a period of time after this operation returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete.

It mirrors To the following Smartsheet REST API method: POST /groups/{groupId}/members

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 AddGroupMembers ( long groupId, IEnumerable groupMembers ) : IList
groupId long the Id of the group
groupMembers IEnumerable array of Group Member objects
return IList

CreateGroup() public method

Creates a new Group.

It mirrors To the following Smartsheet REST API method: POST /groups

This operation is only available to group administrators and system administrators.
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 CreateGroup ( Group group ) : Group
group Group the group object
return Group

DeleteGroup() public method

Deletes the Group specified in the URL.

This operation is only available to system administrators.

It mirrors To the following Smartsheet REST API method: DELETE /groups/{groupId}

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 DeleteGroup ( long groupId ) : void
groupId long the Id of the group
return void

GetGroup() public method

Gets the Group specified in the URL.

It mirrors To the following Smartsheet REST API method: GET /groups/{groupId}

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 GetGroup ( long groupId ) : Group
groupId long
return Group

GroupResourcesImpl() public method

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

ListGroups() public method

List all Users.

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

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 ListGroups ( PaginationParameters paging ) : PaginatedResult
paging PaginationParameters the pagination
return PaginatedResult

RemoveGroupMember() public method

Removes a member from a Group.

This operation is only available to group administrators and system administrators.

This operation is asynchronous, meaning group members may retain their sharing access for a brief period of time after the call returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete.

It mirrors To the following Smartsheet REST API method: DELETE /groups/{groupId}/members/{userId}

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 RemoveGroupMember ( long groupId, long userId ) : void
groupId long the Id of the group
userId long the Id of the user
return void

UpdateGroup() public method

Updates the Group specified in the URL.

It mirrors To the following Smartsheet REST API method: PUT /groups/{groupId}

This operation is only available to group administrators and system administrators.
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 UpdateGroup ( Group group ) : Group
group Group the group To update
return Group