Class MultiShare.ShareToManyBuilder

Namespace

Smartsheet.Api.Models

Assembly

smartsheet-csharp-sdk.dll

A convenience class for creating a MultiShare object with the necessary fields for sharing a sheet with many Users.

public class MultiShare.ShareToManyBuilder

Inheritance

object

MultiShare.ShareToManyBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AccessLevel

Gets the access level.

public AccessLevel? AccessLevel { get; }

Property Value

AccessLevel?

the access level

CCMe

Gets the cc me.

public bool? CCMe { get; }

Property Value

bool?

the cc me

Message

Gets the Message.

public string Message { get; }

Property Value

string

the Message

Subject

Gets the Subject.

public string Subject { get; }

Property Value

string

the Subject

Users

Gets the Users.

public IList<User> Users { get; }

Property Value

IList<User>

the Users

Methods

Build()

Builds the Multishare object with the set fields.

public MultiShare Build()

Returns

MultiShare

the multi share

SetAccessLevel(AccessLevel?)

Sets the access level.

public MultiShare.ShareToManyBuilder SetAccessLevel(AccessLevel? accessLevel)

Parameters

accessLevel AccessLevel?

the access level

Returns

MultiShare.ShareToManyBuilder

the share to many builder

SetCCMe(bool?)

Set the carbon copy me flag.

public MultiShare.ShareToManyBuilder SetCCMe(bool? ccMe)

Parameters

ccMe bool?

the carbon copy me flag.

Returns

MultiShare.ShareToManyBuilder

the share to many builder

SetMessage(string)

Sets the Message to be included in the body of the Email that will be sent to the use.

public MultiShare.ShareToManyBuilder SetMessage(string message)

Parameters

message string

the Message

Returns

MultiShare.ShareToManyBuilder

the share to many builder

SetSubject(string)

Sets the Subject of the Email that sent to notify the Users.

public MultiShare.ShareToManyBuilder SetSubject(string subject)

Parameters

subject string

the Subject

Returns

MultiShare.ShareToManyBuilder

the share to many builder

SetUsers(IList<User>)

Sets the Users that will be shared with. The Email address must be defined for each user.

public MultiShare.ShareToManyBuilder SetUsers(IList<User> users)

Parameters

users IList<User>

the Users

Returns

MultiShare.ShareToManyBuilder

the share to many builder