com.smartsheet.api.models

Class Share.CreateUserShareBuilder

java.lang.Object

com.smartsheet.api.models.Share.CreateUserShareBuilder

Enclosing class:

Share

public static class Share.CreateUserShareBuilder
extends Object

A convenience class for creating a Share with the necessary fields to create a ShareType.USER Share. You must set one and only of of emailAddress and userId.

Constructor Summary

Constructors

Constructor and Description
CreateUserShareBuilder()

Method Summary

Modifier and Type	Method and Description
Share	build() Builds the Share object.
AccessLevel	getAccessLevel()
String	getEmailAddress() Gets the email address.
Long	getUserId() Gets the user Id.
Share.CreateUserShareBuilder	setAccessLevel(AccessLevel accessLevel)
Share.CreateUserShareBuilder	setEmailAddress(String emailAddress) Email address for the ShareType.USER share.
Share.CreateUserShareBuilder	setUserId(Long userId) User ID for the ShareType.USER share.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateUserShareBuilder

public CreateUserShareBuilder()

Method Detail

setEmailAddress

public Share.CreateUserShareBuilder setEmailAddress(String emailAddress)

Email address for the ShareType.USER share.

Parameters:

emailAddress - the email address

Returns:

the Share.CreateUserShareBuilder

getEmailAddress

public String getEmailAddress()

Gets the email address.

Returns:

the email address

setUserId

public Share.CreateUserShareBuilder setUserId(Long userId)

User ID for the ShareType.USER share.

Parameters:

userId - user id

Returns:

the update share builder

getUserId

public Long getUserId()

Gets the user Id.

Returns:

the email address

getAccessLevel

public AccessLevel getAccessLevel()

setAccessLevel

public Share.CreateUserShareBuilder setAccessLevel(AccessLevel accessLevel)

build

public Share build()

Builds the Share object.

Returns:

the share