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 |
|---|---|
ContactResources |
contactResources()
Returns the ContactResources instance that provides access to contact resources.
|
EventResources |
eventResources()
Returns the EventResources instance that provides access to event resources
|
FavoriteResources |
favoriteResources()
Returns the FavoriteResources instance that provides access to Favorite resources.
|
FolderResources |
folderResources()
Returns the FolderResources instance that provides access to Folder resources.
|
GroupResources |
groupResources()
Returns the
GroupResources instance that provides access to Group resources. |
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
|
PassthroughResources |
passthroughResources()
Returns the PassthroughResources instance that provides access to passthrough resources
|
ReportResources |
reportResources()
Returns the ReportResources instance that provides access to report resources.
|
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 |
setChangeAgent(String changeAgent)
Set the change agent identifier.
|
void |
setMaxRetryTimeMillis(long maxRetryTimeMillis)
Sets the max retry time if the HttpClient is an instance of DefaultHttpClient
|
void |
setTracePrettyPrint(boolean pretty)
enable/disable pretty JSON trace logging
|
void |
setTraces(Trace... levels)
Enable request/response tracing in client
|
void |
setUserAgent(String userAgent)
Set the user agent header string.
|
SheetResources |
sheetResources()
Returns the SheetResources instance that provides access to Sheet resources.
|
SightResources |
sightResources()
Returns the SightResources instance that provides access to Sight resources.
|
TemplateResources |
templateResources()
Returns the TemplateResources instance that provides access to Template resources.
|
TokenResources |
tokenResources()
Returns the TokenResources instance that provides access to token resources.
|
UserResources |
userResources()
Returns the UserResources instance that provides access to User resources.
|
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 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 compactvoid setAccessToken(String accessToken)
Set the access token to use.
accessToken - the new access tokenIllegalArgumentException - if any argument is null/empty stringvoid setAssumedUser(String assumedUser)
Set the email of the user to assume.
assumedUser - the new assumed userIllegalArgumentException - if any argument is null/empty stringvoid setChangeAgent(String changeAgent)
Set the change agent identifier.
changeAgent - the new change agentIllegalArgumentException - if any argument is null/empty stringvoid setUserAgent(String userAgent)
Set the user agent header string.
userAgent - the new user agent stringIllegalArgumentException - if any argument is null/empty stringvoid setMaxRetryTimeMillis(long maxRetryTimeMillis)
Sets the max retry time if the HttpClient is an instance of DefaultHttpClient
maxRetryTimeMillis - max retry timeHomeResources 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()
PassthroughResources passthroughResources()
EventResources eventResources()
Copyright © 2014–2019 Smartsheet. All rights reserved.