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

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

Public Methods

Method Description
AddUserBuilder ( string email, bool admin, bool licensedSheetCreator ) : System

User object with required attributes

Build ( ) : User

Builds the User object using the required fields.

GetAdmin ( ) : bool?

Gets the Admin.

GetEmailAddress ( ) : string

Gets the Email address.

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 ) : AddUserBuilder

Sets the Admin flag which allows managing Users and accounts.

SetEmail ( string email ) : AddUserBuilder

Sets the Email for the user.

SetFirstName ( string firstName ) : AddUserBuilder

Sets the user's first name.

SetLastName ( string lastName ) : AddUserBuilder

Sets the user's last name.

SetLicensedSheetCreator ( bool licensedSheetCreator ) : AddUserBuilder

Sets the licensed sheet creator flag that allows creating and owning Sheets.

SetResourceViewer ( bool resourceViewer ) : AddUserBuilder

Sets the Flag indicating whether the user is a resource viewer (can access resource views)

Method Details

AddUserBuilder() public method

User object with required attributes
public AddUserBuilder ( string email, bool admin, bool licensedSheetCreator ) : System
email string email (required)
admin bool admin (required)
licensedSheetCreator bool licensedSheetCreator (required)
return System

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?

GetEmailAddress() public method

Gets the Email address.
public GetEmailAddress ( ) : string
return string

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 ) : AddUserBuilder
admin bool the Admin
return AddUserBuilder

SetEmail() public method

Sets the Email for the user.
public SetEmail ( string email ) : AddUserBuilder
email string the Email
return AddUserBuilder

SetFirstName() public method

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

SetLastName() public method

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

SetLicensedSheetCreator() public method

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

SetResourceViewer() public method

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