C# Class Smartsheet.Api.Models.User.UpdateUserBuilder

A convenience class for making a User object with the appropriate fields for updating a user.
Show file Open project: smartsheet-platform/smartsheet-csharp-sdk

Public Methods

Method Description
Build ( ) : User

Builds the User object using the required fields.
GetAdmin ( ) : bool?

Gets the Admin.
GetFirstName ( ) : string

Gets the user's first name.
GetLastName ( ) : string

Gets the user's last name.
GetLicensedSheetCreator ( ) : bool?

Gets the licensed sheet creator.
GetResourceViewer ( ) : bool?

Gets the Flag indicating whether the user is a resource viewer (can access resource views).
SetAdmin ( bool admin ) : UpdateUserBuilder

Sets the Admin flag which allows managing Users and accounts.
SetFirstName ( string firstName ) : UpdateUserBuilder

Sets the user's first name.
SetLastName ( string lastName ) : UpdateUserBuilder

Sets the user's last name.
SetLicensedSheetCreator ( bool licensedSheetCreator ) : UpdateUserBuilder

Sets the licensed sheet creator flag that allows creating and owning Sheets.
SetResourceViewer ( bool resourceViewer ) : UpdateUserBuilder

Sets the Flag indicating whether the user is a resource viewer (can access resource views)
UpdateUserBuilder ( long id, bool admin, bool licensedSheetCreator ) : System

User object containing the required attributes:

Method Details

Build() public method

Builds the User object using the required fields.
public Build ( ) : User
return User

GetAdmin() public method

Gets the Admin.
public GetAdmin ( ) : bool?
return bool?

GetFirstName() public method

Gets the user's first name.
public GetFirstName ( ) : string
return string

GetLastName() public method

Gets the user's last name.
public GetLastName ( ) : string
return string

GetLicensedSheetCreator() public method

Gets the licensed sheet creator.
public GetLicensedSheetCreator ( ) : bool?
return bool?

GetResourceViewer() public method

Gets the Flag indicating whether the user is a resource viewer (can access resource views).
public GetResourceViewer ( ) : bool?
return bool?

SetAdmin() public method

Sets the Admin flag which allows managing Users and accounts.
public SetAdmin ( bool admin ) : UpdateUserBuilder
admin bool the Admin
return UpdateUserBuilder

SetFirstName() public method

Sets the user's first name.
public SetFirstName ( string firstName ) : UpdateUserBuilder
firstName string the firstName
return UpdateUserBuilder

SetLastName() public method

Sets the user's last name.
public SetLastName ( string lastName ) : UpdateUserBuilder
lastName string the lastName
return UpdateUserBuilder

SetLicensedSheetCreator() public method

Sets the licensed sheet creator flag that allows creating and owning Sheets.
public SetLicensedSheetCreator ( bool licensedSheetCreator ) : UpdateUserBuilder
licensedSheetCreator bool the licensed sheet creator
return UpdateUserBuilder

SetResourceViewer() public method

Sets the Flag indicating whether the user is a resource viewer (can access resource views)
public SetResourceViewer ( bool resourceViewer ) : UpdateUserBuilder
resourceViewer bool the resourceViewer
return UpdateUserBuilder

UpdateUserBuilder() public method

User object containing the required attributes:
public UpdateUserBuilder ( long id, bool admin, bool licensedSheetCreator ) : System
id long the user id
admin bool admin (required)
licensedSheetCreator bool licensedSheetCreator (required)
return System