C# Class Smartsheet.Api.Models.Share.CreateShareBuilder

A convenience class for creating a Share with the necessary fields for sharing the sheet To one user.

Show file Open project: smartsheet-platform/smartsheet-csharp-sdk Class Usage Examples

Public Methods

Method	Description
Build ( ) : Share	Builds the Share object.
CreateShareBuilder ( long groupId, AccessLevel accessLevel ) : System	Sets the required properties for sharing to a Group.
CreateShareBuilder ( string email, AccessLevel accessLevel ) : System	Sets the required properties for sharing to a User.
GetAccessLevel ( ) : AccessLevel?	Gets the access level.
GetCcMe ( ) : bool?	Gets the CcMe.
GetEmail ( ) : string	Gets the Email.
GetGroupId ( ) : long?	Gets the GroupId.
GetMessage ( ) : string	Gets the Message.
GetSubject ( ) : string	Gets the Subject.
SetAccessLevel ( AccessLevel accessLevel ) : CreateShareBuilder	(required) Access level for this specific share.
SetAccessLevel ( string message ) : CreateShareBuilder	(optional): The message to be included in the body of the email that will optionally be sent to the recipient.
SetCcMe ( bool ccMe ) : CreateShareBuilder	(optional): Boolean flag to indicate whether or not to CC the user sharing the sheet.
SetEmail ( string email ) : CreateShareBuilder	(optional) Email address for this specific share. NOTE: One of email or groupId must be specified, but not both.
SetGroupId ( long groupId ) : CreateShareBuilder	the group share recipient’s group ID. NOTE: One of email or groupId must be specified, but not both.
SetSubject ( string subject ) : CreateShareBuilder	(optional): The subject of the email that will optionally be sent to notify the recipient.

Method Details

Build() public method

Builds the Share object.

public Build ( ) : Share
return	Share

CreateShareBuilder() public method

Sets the required properties for sharing to a Group.

public CreateShareBuilder ( long groupId, AccessLevel accessLevel ) : System
groupId	long	the group ID
accessLevel	AccessLevel	the Access Level
return	System

CreateShareBuilder() public method

Sets the required properties for sharing to a User.

public CreateShareBuilder ( string email, AccessLevel accessLevel ) : System
email	string	the email of the User
accessLevel	AccessLevel	the Access Level
return	System

GetAccessLevel() public method

Gets the access level.

public GetAccessLevel ( ) : AccessLevel?
return	AccessLevel?

GetCcMe() public method

Gets the CcMe.

public GetCcMe ( ) : bool?
return	bool?

GetEmail() public method

Gets the Email.

public GetEmail ( ) : string
return	string

GetGroupId() public method

Gets the GroupId.

public GetGroupId ( ) : long?
return	long?

GetMessage() public method

Gets the Message.

public GetMessage ( ) : string
return	string

GetSubject() public method

Gets the Subject.

public GetSubject ( ) : string
return	string

SetAccessLevel() public method

(required) Access level for this specific share.

public SetAccessLevel ( AccessLevel accessLevel ) : CreateShareBuilder
accessLevel	AccessLevel	the access level
return	CreateShareBuilder

SetAccessLevel() public method

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

public SetAccessLevel ( string message ) : CreateShareBuilder
message	string	the message
return	CreateShareBuilder

SetCcMe() public method

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

public SetCcMe ( bool ccMe ) : CreateShareBuilder
ccMe	bool	the ccMe
return	CreateShareBuilder

SetEmail() public method

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

public SetEmail ( string email ) : CreateShareBuilder
email	string	the Email
return	CreateShareBuilder

SetGroupId() public method

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

public SetGroupId ( long groupId ) : CreateShareBuilder
groupId	long	the groupId
return	CreateShareBuilder

SetSubject() public method

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

public SetSubject ( string subject ) : CreateShareBuilder
subject	string	the subject
return	CreateShareBuilder