Class User.AddUserBuilder

Namespace

Smartsheet.Api.Models

Assembly

smartsheet-csharp-sdk.dll

A convenience class for making a User object with the appropriate fields for adding the user.

public class User.AddUserBuilder

Inheritance

object

User.AddUserBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AddUserBuilder(string, bool?, bool?)

User object with required attributes

public AddUserBuilder(string email, bool? admin, bool? licensedSheetCreator)

Parameters

email string

email (required)

admin bool?

admin (required)

licensedSheetCreator bool?

licensedSheetCreator (required)

Methods

Build()

Builds the User object using the required fields.

public User Build()

Returns

User

the user

GetAdmin()

Gets the Admin.

public bool? GetAdmin()

Returns

bool?

the Admin

GetEmailAddress()

Gets the Email address.

public string GetEmailAddress()

Returns

string

the Email address

GetFirstName()

Gets the user's first name.

public string GetFirstName()

Returns

string

the firstName

GetLastName()

Gets the user's last name.

public string GetLastName()

Returns

string

the lastName

GetLicensedSheetCreator()

Gets the licensed sheet creator.

public bool? GetLicensedSheetCreator()

Returns

bool?

the licensed sheet creator

GetResourceViewer()

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

public bool? GetResourceViewer()

Returns

bool?

the resourceViewer

SetAdmin(bool?)

Sets the Admin flag which allows managing Users and accounts.

public User.AddUserBuilder SetAdmin(bool? admin)

Parameters

admin bool?

the Admin

Returns

User.AddUserBuilder

the adds the user builder

SetEmail(string)

Sets the Email for the user.

public User.AddUserBuilder SetEmail(string email)

Parameters

email string

the Email

Returns

User.AddUserBuilder

the adds the user builder

SetFirstName(string)

Sets the user's first name.

public User.AddUserBuilder SetFirstName(string firstName)

Parameters

firstName string

the firstName

Returns

User.AddUserBuilder

the adds the user builder

SetLastName(string)

Sets the user's last name.

public User.AddUserBuilder SetLastName(string lastName)

Parameters

lastName string

the lastName

Returns

User.AddUserBuilder

the adds the user builder

SetLicensedSheetCreator(bool?)

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

public User.AddUserBuilder SetLicensedSheetCreator(bool? licensedSheetCreator)

Parameters

licensedSheetCreator bool?

the licensed sheet creator

Returns

User.AddUserBuilder

the adds the user builder

SetResourceViewer(bool?)

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

public User.AddUserBuilder SetResourceViewer(bool? resourceViewer)

Parameters

resourceViewer bool?

the resourceViewer

Returns

User.AddUserBuilder

the adds the user builder