Table of Contents

Class AssetShare.CreateAssetShareBuilder

Namespace
Smartsheet.Api.Models
Assembly
smartsheet-csharp-sdk.dll

A convenience class for creating a AssetShare with the necessary fields for sharing the sheet to one user.

public class AssetShare.CreateAssetShareBuilder
Inheritance
AssetShare.CreateAssetShareBuilder
Inherited Members

Constructors

CreateAssetShareBuilder(AccessLevel?)

Sets the required properties for sharing. Note: Since both email and groupId are strings in AssetShare, use SetEmail() or SetGroupId() to specify the recipient after construction.

public CreateAssetShareBuilder(AccessLevel? accessLevel)

Parameters

accessLevel AccessLevel?

the Access Level

Methods

Build()

Builds the AssetShare object.

public AssetShare Build()

Returns

AssetShare

the share

GetAccessLevel()

Gets the access level.

public AccessLevel? GetAccessLevel()

Returns

AccessLevel?

the access level

GetCcMe()

Gets the CcMe.

public bool? GetCcMe()

Returns

bool?

the CcMe

GetEmail()

Gets the Email.

public string GetEmail()

Returns

string

the Email

GetGroupId()

Gets the GroupId.

public string GetGroupId()

Returns

string

the GroupId

GetMessage()

Gets the Message.

public string GetMessage()

Returns

string

the Message

GetSubject()

Gets the Subject.

public string GetSubject()

Returns

string

the Subject

SetAccessLevel(AccessLevel?)

(required) Access level for this specific share.

public AssetShare.CreateAssetShareBuilder SetAccessLevel(AccessLevel? accessLevel)

Parameters

accessLevel AccessLevel?

the access level

Returns

AssetShare.CreateAssetShareBuilder

the share to one builder

SetCcMe(bool?)

(optional): Boolean flag to indicate whether or not to CC the user sharing the sheet.

public AssetShare.CreateAssetShareBuilder SetCcMe(bool? ccMe)

Parameters

ccMe bool?

the ccMe

Returns

AssetShare.CreateAssetShareBuilder

the share to one builder

SetEmail(string)

(optional) Email address for this specific share. NOTE: One of email or groupId must be specified, but not both.

public AssetShare.CreateAssetShareBuilder SetEmail(string email)

Parameters

email string

the Email

Returns

AssetShare.CreateAssetShareBuilder

the share to one builder

SetGroupId(string)

the group share recipient's group ID. NOTE: One of email or groupId must be specified, but not both.

public AssetShare.CreateAssetShareBuilder SetGroupId(string groupId)

Parameters

groupId string

the groupId

Returns

AssetShare.CreateAssetShareBuilder

the share to one builder

SetMessage(string)

(optional): The message to be included in the body of the email that will optionally be sent to the recipient.

public AssetShare.CreateAssetShareBuilder SetMessage(string message)

Parameters

message string

the message

Returns

AssetShare.CreateAssetShareBuilder

the share to one builder

SetSubject(string)

(optional): The subject of the email that will optionally be sent to notify the recipient.

public AssetShare.CreateAssetShareBuilder SetSubject(string subject)

Parameters

subject string

the subject

Returns

AssetShare.CreateAssetShareBuilder

the share to one builder

Edit this page