com.smartsheet.api.models

Class Share

java.lang.Object

com.smartsheet.api.models.IdentifiableModel<T>

com.smartsheet.api.models.NamedModel<String>

com.smartsheet.api.models.Share

public class Share
extends NamedModel<String>

Represents a Share Object.

See Also:

Sharing Sheets

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Share.CreateGroupShareBuilder A convenience class for creating a Share with the necessary fields to create a ShareType.GROUP Share.
static class	Share.CreateUserShareBuilder A convenience class for creating a Share with the necessary fields to create a ShareType.USER Share.
static class	Share.ShareToOneGroupBuilder A convenience class for creating a Share with the necessary fields for sharing the sheet to one Group.
static class	Share.ShareToOneUserBuilder A convenience class for creating a Share with the necessary fields for sharing the sheet to one user.
static class	Share.UpdateShareBuilder A convenience class for creating a Share with the necessary fields to update a specific share.

Constructor Summary

Constructors

Constructor and Description
Share()

Method Summary

Modifier and Type	Method and Description
AccessLevel	getAccessLevel() Gets the access level for this specific share.
Date	getCreatedAt() Gets the time that the share was created
String	getEmail() Gets the email for this specific share.
Long	getGroupId()
String	getMessage() Gets the message to be included in the body of the email.
Date	getModifiedAt() Gets the time that the share was last modified
ShareScope	getScope() Get the scope of this share.
String	getSubject() Gets the subject of the email that will optionally be sent to notify the recipient.
ShareType	getType()
Long	getUserId()
Boolean	isCcMe() Gets the flag to indicate whether or not to send a copy of the email to the sharer
Share	setAccessLevel(AccessLevel accessLevel) Sets the access level for this specific share.
Share	setCcMe(Boolean ccMe) Sets the flag to indicate whether or not to send a copy of the email to the sharer.
Share	setCreatedAt(Date createdAt) Sets the time that the share was created
Share	setEmail(String email) Sets the email for this specific share.
Share	setGroupId(Long groupId)
Share	setMessage(String message) Sets the message to be included in the body of the email.
Share	setModifiedAt(Date modifiedAt) Sets the time that the share was last modified
Share	setName(String name) Provide an 'override' of setName (returns Share not NamedModel)
Share	setScope(ShareScope scope) Set the scope of this share.
Share	setSubject(String subject) Sets the subject of the email that will optionally be sent to notify the recipient.
Share	setType(ShareType type)
Share	setUserId(Long userId)

Methods inherited from class com.smartsheet.api.models.NamedModel

getName

Methods inherited from class com.smartsheet.api.models.IdentifiableModel

equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

Share

public Share()

Method Detail

setName

public Share setName(String name)

Provide an 'override' of setName (returns Share not NamedModel)

Overrides:

setName in class NamedModel<String>

Parameters:

name - the new name

getSubject

public String getSubject()

Gets the subject of the email that will optionally be sent to notify the recipient.

Returns:

the subject

setSubject

public Share setSubject(String subject)

Sets the subject of the email that will optionally be sent to notify the recipient.

Parameters:

subject - the subject of the email

getMessage

public String getMessage()

Gets the message to be included in the body of the email.

Returns:

the message

setMessage

public Share setMessage(String message)

Sets the message to be included in the body of the email.

Parameters:

message - the message

isCcMe

public Boolean isCcMe()

Gets the flag to indicate whether or not to send a copy of the email to the sharer

Returns:

the flag for CC

setCcMe

public Share setCcMe(Boolean ccMe)

Sets the flag to indicate whether or not to send a copy of the email to the sharer.

Parameters:

ccMe - the flag for CC

getAccessLevel

public AccessLevel getAccessLevel()

Gets the access level for this specific share.

Returns:

the access level

setAccessLevel

public Share setAccessLevel(AccessLevel accessLevel)

Sets the access level for this specific share.

Parameters:

accessLevel - the new access level

getEmail

public String getEmail()

Gets the email for this specific share.

Returns:

the email

setEmail

public Share setEmail(String email)

Sets the email for this specific share.

Parameters:

email - the new email

getScope

public ShareScope getScope()

Get the scope of this share. One of ITEM or WORKSPACE

Returns:

scope

setScope

public Share setScope(ShareScope scope)

Set the scope of this share. One of ITEM or WORKSPACE

Parameters:

scope -

getCreatedAt

public Date getCreatedAt()

Gets the time that the share was created

Returns:

createdAt

setCreatedAt

public Share setCreatedAt(Date createdAt)

Sets the time that the share was created

Parameters:

createdAt -

getModifiedAt

public Date getModifiedAt()

Gets the time that the share was last modified

Returns:

modifiedAt

setModifiedAt

public Share setModifiedAt(Date modifiedAt)

Sets the time that the share was last modified

Parameters:

modifiedAt -

getUserId

public Long getUserId()

Returns:

the userId, null if is ShareType.GROUP

setUserId

public Share setUserId(Long userId)

Parameters:

userId - the userId to set

getGroupId

public Long getGroupId()

Returns:

the groupId, null if is ShareType.USER

setGroupId

public Share setGroupId(Long groupId)

Parameters:

groupId - the groupId to set

getType

public ShareType getType()

Returns:

the type

setType

public Share setType(ShareType type)

Parameters:

type - the ShareType to set