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

GetIsInternal()

Gets the is internal.

public bool? GetIsInternal()

Returns

bool?

the is internal

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

GetPlanId()

Gets the plan ID.

public long? GetPlanId()

Returns

long?

the plan ID

GetProvisionalExpirationDate()

Gets expiration date of the provisional seat type of the user.

public DateTime? GetProvisionalExpirationDate()

Returns

DateTime?

the provisional expiration date

GetResourceViewer()

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

public bool? GetResourceViewer()

Returns

bool?

the resourceViewer

GetSeatType()

Gets the seat type.

public SeatType? GetSeatType()

Returns

SeatType?

the seat type

GetSeatTypeLastChangedAt()

Gets the seat type last changed at.

public DateTime? GetSeatTypeLastChangedAt()

Returns

DateTime?

the seat type last changed at

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

SetIsInternal(bool?)

Sets the is internal.

public User.AddUserBuilder SetIsInternal(bool? isInternal)

Parameters

isInternal bool?

the is internal

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

SetPlanId(long?)

Sets the plan ID.

public User.AddUserBuilder SetPlanId(long? planId)

Parameters

planId long?

the plan ID

Returns

User.AddUserBuilder

the adds the user builder

SetProvisionalExpirationDate(DateTime?)

Sets the expiration date of the provisional seat type of the user.

public User.AddUserBuilder SetProvisionalExpirationDate(DateTime? provisionalExpirationDate)

Parameters

provisionalExpirationDate DateTime?

the provisional expiration date

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

SetSeatType(SeatType?)

Sets the seat type.

public User.AddUserBuilder SetSeatType(SeatType? seatType)

Parameters

seatType SeatType?

the seat type

Returns

User.AddUserBuilder

the adds the user builder

SetSeatTypeLastChangedAt(DateTime?)

Sets the seat type last changed at.

public User.AddUserBuilder SetSeatTypeLastChangedAt(DateTime? seatTypeLastChangedAt)

Parameters

seatTypeLastChangedAt DateTime?

the seat type last changed at

Returns

User.AddUserBuilder

the adds the user builder