public interface Smartsheet
This interface is the entry point of the Smartsheet SDK, it provides convenient methods to get XXXResources instances for accessing different types of resources.
Thread Safety: Implementation of this interface must be thread safe.
| Modifier and Type | Method and Description |
|---|---|
AttachmentResources |
attachments()
Deprecated.
As of release 2.0; example: use sheetResources().attachmentResources() for sheet-level attachments
|
ColumnResources |
columns()
Deprecated.
As of release 2.0, use sheetResources().columnResources()
|
CommentResources |
comments()
Deprecated.
As of release 2.0; example: use sheetResources().discussionResources().commentResources() for discussion-level comments
|
ContactResources |
contactResources()
Returns the ContactResources instance that provides access to contact resources.
|
void |
discussions()
Deprecated.
As of release 2.0; example: use sheetResources().discussionResources() for sheet-level discussions
|
FavoriteResources |
favoriteResources()
Returns the FavoriteResources instance that provides access to Favorite resources.
|
FolderResources |
folderResources()
Returns the FolderResources instance that provides access to Folder resources.
|
void |
folders()
Deprecated.
As of release 2.0, replaced by
folderResources() |
GroupResources |
groupResources()
Returns the
GroupResources instance that provides access to Group resources. |
void |
groups()
Deprecated.
As of release 2.0, replaced by
groupResources() |
void |
home()
Deprecated.
As of release 2.0, replaced by
homeResources() |
HomeResources |
homeResources()
Returns the HomeResources instance that provides access to Home resources.
|
ImageUrlResources |
imageUrlResources()
Returns the ImageUrlResources instance that provides access to image Url resources
|
ReportResources |
reportResources()
Returns the ReportResources instance that provides access to report resources.
|
void |
rows()
Deprecated.
As of release 2.0, use sheetResources().rowResources()
|
void |
search()
Deprecated.
As of release 2.0, replaced by
searchResources() |
SearchResources |
searchResources()
Returns the SearchResources instance that provides access to searching resources.
|
ServerInfoResources |
serverInfoResources()
Returns the
ServerInfoResources instance that provides access to Server Info resources. |
void |
setAccessToken(String accessToken)
Set the access token to use.
|
void |
setAssumedUser(String assumedUser)
Set the email of the user to assume.
|
void |
setTracePrettyPrint(boolean pretty)
enable/disable pretty JSON trace logging
|
void |
setTraces(Trace... levels)
Enable request/response tracing in client
|
SheetResources |
sheetResources()
Returns the SheetResources instance that provides access to Sheet resources.
|
void |
sheets()
Deprecated.
As of release 2.0, replaced by
sheetResources() |
SightResources |
sightResources()
Returns the SightResources instance that provides access to Sight resources.
|
TemplateResources |
templateResources()
Returns the TemplateResources instance that provides access to Template resources.
|
void |
templates()
Deprecated.
As of release 2.0, replaced by
templateResources() |
TokenResources |
tokenResources()
Returns the TokenResources instance that provides access to token resources.
|
UserResources |
userResources()
Returns the UserResources instance that provides access to User resources.
|
void |
users()
Deprecated.
As of release 2.0, replaced by
userResources() |
WebhookResources |
webhookResources()
Returns the WebhookResources instance that provides access to webhook resources
|
WorkspaceResources |
workspaceResources()
Returns the WorkspaceResources instance that provides access to Workspace resources.
|
void |
workspaces()
Deprecated.
As of release 2.0, replaced by
workspaceResources() |
HomeResources homeResources()
Returns the HomeResources instance that provides access to Home resources.
WorkspaceResources workspaceResources()
Returns the WorkspaceResources instance that provides access to Workspace resources.
FolderResources folderResources()
Returns the FolderResources instance that provides access to Folder resources.
TemplateResources templateResources()
Returns the TemplateResources instance that provides access to Template resources.
SheetResources sheetResources()
Returns the SheetResources instance that provides access to Sheet resources.
SightResources sightResources()
Returns the SightResources instance that provides access to Sight resources.
FavoriteResources favoriteResources()
Returns the FavoriteResources instance that provides access to Favorite resources.
UserResources userResources()
Returns the UserResources instance that provides access to User resources.
GroupResources groupResources()
Returns the GroupResources instance that provides access to Group resources.
ServerInfoResources serverInfoResources()
Returns the ServerInfoResources instance that provides access to Server Info resources.
SearchResources searchResources()
Returns the SearchResources instance that provides access to searching resources.
ReportResources reportResources()
Returns the ReportResources instance that provides access to report resources.
TokenResources tokenResources()
Returns the TokenResources instance that provides access to token resources.
ContactResources contactResources()
Returns the ContactResources instance that provides access to contact resources.
ImageUrlResources imageUrlResources()
WebhookResources webhookResources()
void setAssumedUser(String assumedUser)
Set the email of the user to assume.
assumedUser - the new assumed userIllegalArgumentException - if any argument is null/empty stringvoid setAccessToken(String accessToken)
Set the access token to use.
accessToken - the new access tokenIllegalArgumentException - if any argument is null/empty stringvoid setTraces(Trace... levels)
Enable request/response tracing in client
levels - - what to trace (if anything; null if not tracing at all)void setTracePrettyPrint(boolean pretty)
pretty - if the JSON is nicely-formatted or compact@Deprecated void home()
homeResources()@Deprecated void workspaces()
workspaceResources()@Deprecated void folders()
folderResources()@Deprecated void templates()
templateResources()@Deprecated void sheets()
sheetResources()@Deprecated ColumnResources columns()
@Deprecated void rows()
@Deprecated AttachmentResources attachments()
@Deprecated void discussions()
@Deprecated CommentResources comments()
@Deprecated void users()
userResources()@Deprecated void groups()
groupResources()@Deprecated void search()
searchResources()Copyright © 2014–2017 Smartsheet. All rights reserved.