All Classes Interface Summary Class Summary Enum Summary Exception Summary
| Class |
Description |
| AbstractRow<TColumn extends Column,TCell extends Cell> |
|
| AbstractSheet<TRow extends AbstractRow<TColumn,TCell>,TColumn extends Column,TCell extends Cell> |
|
| AccessDeniedException |
This is the exception thrown by OAuthFlow to indicate "access_denied" error when obtaining an authorization code. |
| AccessLevel |
Represents access levels that users can have.
|
| AccessScope |
Represents the type of access that is granted on a given sheet.
|
| AccessScope |
Represents the access scope.
|
| AccessTokenExpiredException |
This is the exception to indicate that an access token expired error returned from Smartsheet REST API.
|
| Account |
|
| AlternateEmail |
|
| AlternateEmail.AddAlternateEmailBuilder |
A convenience class for making a AlternateEmail object with the appropriate fields for adding to a User. |
| AssetShareResources |
This interface provides methods to access Asset Share resources.
|
| AssociatedAttachmentResources |
Deprecated, for removal: This API element is subject to removal in a future version.
|
| AssociatedDiscussionResources |
Deprecated, for removal: This API element is subject to removal in a future version.
|
| Attachment |
Represents the Attachment object.
|
| Attachment.CreateAttachmentBuilder |
A convenience class for quickly creating a List of cells to update.
|
| AttachmentParentType |
Represents the attachment parent type.
|
| AttachmentResources |
Deprecated, for removal: This API element is subject to removal in a future version.
|
| AttachmentSubType |
Represents the attachment sub type.
|
| AttachmentType |
Represents the type of attachment.
|
| AttachmentVersioningResources |
This interface provides methods to access AttachmentVersioning resources.
|
| AuthorizationException |
This is the exception to indicate authorization (access token) related errors returned from Smartsheet REST API.
|
| AuthorizationResult |
Represents an OAuth authorization result.
|
| AutomationAction |
|
| AutomationActionFrequency |
|
| AutomationActionType |
|
| AutomationRule |
|
| AutomationRuleDisabledReason |
|
| AutoNumberFormat |
Represents the AutoNumberFormat object.
|
| Bold |
An enumeration representing the available Bold state for a format.
|
| BooleanObjectValue |
|
| BulkItemFailure |
|
| BulkItemResult<T> |
|
| BulkRowFailedItem |
Created by kskeem on 3/1/16.
|
| Cell |
Represents the Cell object that holds data in a sheet.
|
| Cell.AddRowCellsBuilder |
A convenience class for quickly creating a List of cells to add.
|
| Cell.UpdateRowCellsBuilder |
A convenience class for quickly creating a List of cells to update.
|
| CellDataItem |
|
| CellHistory |
Represents CellHistory object.
|
| CellHistoryInclusion |
Represents specific objects that can be included in some responses.
|
| CellLink |
|
| CellLinkWidgetContent |
|
| ChartWidgetContent |
|
| ChildrenResourceType |
Represents the resource types that can be filtered when getting children of workspaces or folders.
|
| Color |
An enumeration representing all the colors available for formatting within Smartsheet.
|
| Column |
Represents the Column object.
|
| Column.AddColumnToSheetBuilder |
A convenience class to help create a column object with the appropriate fields for adding to a sheet.
|
| Column.UpdateColumnBuilder |
The Class UpdateColumnBuilder.
|
| ColumnInclusion |
Represents specific objects that can be included in some responses.
|
| ColumnResources |
Deprecated, for removal: This API element is subject to removal in a future version.
|
| ColumnTag |
Represents the tags to indicate a special column.
|
| ColumnType |
Represents column types.
|
| Comment |
Represents the Comment object.
|
| Comment.AddCommentBuilder |
A convenience class to generate a comment with the appropriate fields for adding it to a sheet.
|
| CommentAttachmentResources |
This interface provides methods to access CommentAttachment resources.
|
| CommentResources |
Deprecated, for removal: This API element is subject to removal in a future version.
|
| Contact |
Represents the Contact object.
|
| ContactObjectValue |
|
| ContactResources |
|
| ContainerDestination |
|
| ContainerDestination.AddContainerDestinationBuilder |
A convenience class to generate a comment with the appropriate fields for adding it to a sheet.
|
| CopyExclusion |
|
| CopyOrMoveRowDestination |
|
| CopyOrMoveRowDestination.InsertCopyOrMoveRowDestinationBuilder |
A convenience class for quickly creating a List of cells to update.
|
| CopyOrMoveRowDirective |
|
| CopyOrMoveRowDirective.InsertCopyOrMoveRowDirectiveBuilder |
A convenience class to help create a CopyOrMoveRowDestination object with the appropriate fields for adding to a sheet.
|
| CopyOrMoveRowResult |
|
| CreateShareRequest |
Represents a CreateShareRequest object in the Smartsheet API.
|
| CreateShareRequest.CreateShareRequestBuilder |
|
| Criteria |
|
| CriteriaTarget |
|
| CrossSheetReference |
|
| CrossSheetReferenceStatus |
|
| Currency |
|
| Currency |
An enum representing the available currency formats available in Smartsheet.
|
| DateFormat |
|
| DateObjectValue |
|
| DayDescriptor |
|
| DayOfWeek |
|
| DayOrdinal |
|
| DecimalCount |
An enumeration representing the Decimal count formats available in Smartsheet.
|
| DeleteUserParameters |
|
| DestinationType |
Represents the type of the destination container when a Sheet or Folder is moved, or when a Sheet, Folder, or Workspace is copied..
|
| Discussion |
Represents the Discussion object.
|
| Discussion.CreateDiscussionBuilder |
A convenience class to help generate discussion object with the appropriate fields for adding a discussion to
a sheet.
|
| DiscussionAttachmentResources |
|
| DiscussionCommentResources |
|
| DiscussionInclusion |
Represents specific objects that can be included in some responses.
|
| DiscussionResources |
This interface provides methods to access Discussion resources.
|
| DowngradeSeatType |
|
| Duration |
|
| Email |
Represents an Email object.
|
| Error |
Represents Error object.
|
| ErrorDetail |
|
| Event |
|
| EventAction |
|
| EventObjectType |
|
| EventResources |
|
| EventResult |
|
| EventSource |
|
| ExplicitNull |
|
| Favorite |
|
| Favorite.AddFavoriteBuilder |
A convenience class for making a Favorite object with the appropriate fields for adding to a Favorite. |
| FavoriteResources |
|
| FavoriteType |
|
| FeatureInfo |
|
| Folder |
Represents a folder.
|
| Folder.CreateFolderBuilder |
A convenience class for setting up a folder with the appropriate fields for updating the folder.
|
| Folder.UpdateFolderBuilder |
A convenience class for setting up a folder with the appropriate fields for updating the folder.
|
| FolderCopyInclusion |
Represents specific objects that can be included in some responses.
|
| FolderRemapExclusion |
Represents specific objects should be excluded in some responses.
|
| FolderResources |
This interface provides methods to access Folder resources.
|
| FontFamily |
|
| FontFamily |
An enumeration representing the available font families within Smartsheet.
|
| FontSize |
An enumeration representing the available font sizes within Smartsheet.
|
| Format |
This class represents the format as applied to a cell, row or column.
|
| Format.FormatBuilder |
Builder class for a Format object
|
| Format.FormatSerializer |
|
| FormatDetails |
Represents the format details when generating a digital copy (PDF/EXCEL) of a sheet.
|
| FormatTables |
|
| GetFolderChildrenInclusion |
Represents specific objects that can be included in GetFolderChildren responses.
|
| GetFolderMetadataInclusion |
Represents specific objects that can be included in GetFolderMetadata responses.
|
| GetWorkspaceChildrenInclusion |
Represents specific objects that can be included in GetWorkspaceChildren responses.
|
| GetWorkspaceMetadataInclusion |
Represents specific objects that can be included in GetWorkspaceMetadata responses.
|
| GlobalTemplate |
|
| Group |
Represents a Group Object.
|
| Group.CreateGroupBuilder |
A convenience class to make a Group object with the necessary fields to create the group by posting it
to smartsheet. |
| Group.UpdateGroupBuilder |
A convenience class to update a Group object with the necessary fields to create the group by putting it
to smartsheet. |
| GroupMember |
Represents the Group Member object.
|
| GroupMember.AddGroupMemberBuilder |
A convenience class for making a GroupMember object with the appropriate fields for adding to a Group. |
| GroupMemberResources |
This interface provides methods to access Share resources.
|
| GroupResources |
This interface provides methods to access Group resources
|
| Home |
Represents the Home object.
|
| HomeFolderResources |
Deprecated, for removal: This API element is subject to removal in a future version.
|
| HomeResources |
Deprecated, for removal: This API element is subject to removal in a future version.
|
| HorizontalAlignment |
An enumeration representing the available horizontal alignments within Smartsheet.
|
| Hyperlink |
|
| IdentifiableModel<T> |
Represents an object with an ID.
|
| IdentifiableModelMixin<T> |
This is a Jackson Mixin class that excludes "id" field from being serialized to JSON.
|
| Image |
|
| ImageUrl |
|
| ImageUrlMap |
Represents the ImageUrl object.
|
| ImageUrlResources |
|
| ImageWidgetContent |
|
| InvalidOAuthClientException |
This is the exception thrown by OAuthFlow to indicate an "invalid_client" error occurred when obtaining
OAuth tokens. |
| InvalidOAuthGrantException |
This is the exception thrown by OAuthFlow to indicate an "invalid_grant" error occurred when obtaining
OAuth tokens. |
| InvalidRequestException |
This is the exception to indicate invalid request error returned from Smartsheet REST API.
|
| InvalidScopeException |
This is the exception thrown by OAuthFlow to indicate an "invalid_scope" error occurred when obtaining an
authorization code. |
| InvalidTokenRequestException |
This is the exception thrown by OAuthFlow to indicate an "invalid_request" error occurred when obtaining OAuth
tokens. |
| Italic |
An enumeration representing the available Italic state for a format.
|
| ListAssetSharesResponse<T> |
|
| ListBuilder<T> |
Simple class that makes creating type safe lists of object easier
|
| ListUserInclusion |
Represents specific objects that can be included with the ListUsers request.
|
| MultiContactObjectValue |
|
| MultiPicklistObjectValue |
|
| MultiRowEmail |
Represents the multi row email object.
|
| MultiRowEmail.AddMultiRowEmailBuilder |
A convenience class to help create a MultiRowEmail object with the appropriate fields.
|
| NamedModel<T> |
Represents an object with a name and an id.
|
| NumberFormat |
|
| NumberObjectValue |
|
| OAuthAuthorizationCodeException |
This is the exception thrown by OAuthFlow to indicate errors occurred when obtaining authorization code. |
| OAuthFlow |
OAuthFlow interface provides methods to do the OAuth2 authorization.
|
| OAuthFlowBuilder |
This is the builder that is used to build OAuthFlow instances. |
| OAuthTokenException |
This is the exception thrown by OAuthFlow to indicate errors occurred during obtaining OAuth tokens. |
| ObjectExclusion |
Represents specific objects that can be excluded in some responses.
|
| ObjectInclusion |
Represents specific objects that can be included in some responses.
|
| ObjectValue |
|
| ObjectValueType |
|
| Operator |
|
| PagedResult<T> |
A wrapper object used to Wrap the data that comes back from the API.
|
| PaginationParameters |
|
| PaginationParameters.PaginationParametersBuilder |
A convenience class for creating a PaginationParameters object
|
| PaperSize |
Represents page dimensions in the Smartsheet REST API.
|
| ParentType |
|
| PartialRowUpdateResult |
Created by kskeem on 3/1/16.
|
| PassthroughResources |
This interface provides methods to access Passthrough resources.
|
| Predecessor |
|
| PredecessorList |
|
| PrimitiveObjectValue<T> |
|
| ProfileImage |
|
| ProjectSettings |
|
| Recipient |
|
| RecipientEmail |
|
| RecipientEmail.AddRecipientEmailBuilder |
A convenience class to help create a RecipientEmail object with the appropriate fields.
|
| RecipientGroup |
|
| RecipientGroup.AddRecipientGroupBuilder |
A convenience class to help create a RecipientGroup object with the appropriate fields.
|
| Report |
A report object that is a filtered view of the data from one or more Sheets.
|
| ReportCell |
Represents the ReportCell object.
|
| ReportColumn |
Represents the “virtual” Column object for Report.
|
| ReportInclusion |
Represents specific objects that can be included in some responses.
|
| ReportPublish |
The ReportPublish object.
|
| ReportResources |
This interface provides methods to access Report resources.
|
| ReportRow |
Represents the ReportRow object.
|
| ReportWidgetContent |
|
| ResourceManagementType |
Represents the type of resource management.
|
| ResourceNotFoundException |
This is the exception to indicate a resource can not be found.
|
| Result<T> |
Result object to contain information about a PUT or POST request.
|
| Row |
Represents the Row object.
|
| Row.AddRowBuilder |
A convenience class for creating a RowWrapper with the necessary fields for inserting a Row or
set of rows. |
| Row.UpdateRowBuilder |
|
| RowAttachmentResources |
This interface provides methods to access RowAttachment resources.
|
| RowColumnResources |
This interface provides methods to access row column resources that are associated to a sheet object.
|
| RowCopyInclusion |
Represents specific objects that can be included in some responses.
|
| RowDiscussionResources |
This interface provides methods to access Row Discussion resources.
|
| RowEmail |
Represents RowEmail object.
|
| RowEmail.AddRowEmailBuilder |
A convenience class to help create a RowEmail object with the appropriate fields.
|
| RowInclusion |
Represents specific objects that can be included in some responses.
|
| RowMapping |
|
| RowMoveInclusion |
Represents specific objects that can be included in some responses.
|
| RowWrapper |
Represents the RowWrapper object that is used to specify the location for a Row or set of Rows. |
| RowWrapper.InsertRowsBuilder |
A convenience class for creating a RowWrapper with the necessary fields for inserting a Row or
set of rows. |
| RowWrapper.MoveRowBuilder |
A convenience class for creating a RowWrapper with the necessary fields for moving a Row or set
of rows. |
| Schedule |
|
| ScheduleType |
|
| Scope |
|
| SearchInclusion |
|
| SearchLocation |
|
| SearchResources |
This interface provides methods to access search resources.
|
| SearchResult |
Represents the results of a search.
|
| SearchResultItem |
Represents one specific result of a search.
|
| SearchScope |
|
| SeatType |
|
| SelectionRange |
|
| SentUpdateRequest |
|
| ServerInfo |
|
| ServerInfoResources |
This interface provides methods to server information resources.
|
| ServiceUnavailableException |
This is the exception to indicate a service unavailable error (possibly due to rate limiting) returned from the
Smartsheet REST API.
|
| Share |
Represents a Share Object.
|
| Share.CreateGroupShareBuilder |
|
| Share.CreateUserShareBuilder |
|
| Share.ShareToOneGroupBuilder |
A convenience class for creating a Share with the necessary fields for sharing the sheet to one Group. |
| Share.ShareToOneUserBuilder |
A convenience class for creating a Share with the necessary fields for sharing the sheet to one user. |
| Share.UpdateShareBuilder |
A convenience class for creating a Share with the necessary fields to update a specific share. |
| ShareResources |
Deprecated, for removal: This API element is subject to removal in a future version.
|
| ShareResponse |
Represents a ShareResponse object in the Smartsheet API.
|
| ShareScope |
|
| ShareType |
Represents column types.
|
| Sheet |
Represents the Sheet object.
|
| Sheet.CreateFromTemplateOrSheetBuilder |
A class to simplify the creation of a sheet from another sheet or another template.
|
| Sheet.CreateSheetBuilder |
A convenience class to make a Sheet object with the necessary fields to create the sheet by posting it
to smartsheet. |
| Sheet.UpdateSheetBuilder |
The Class UpdateSheetBuilder.
|
| SheetAttachmentResources |
|
| SheetAutomationRuleResources |
|
| SheetColumnResources |
This interface provides methods to access column resources that are associated to a sheet object.
|
| SheetCommentResources |
This interface provides methods to access Sheet Comment resources.
|
| SheetCopyInclusion |
Represents specific objects that can be included in some responses.
|
| SheetCrossSheetReferenceResources |
|
| SheetDiscussionResources |
|
| SheetEmail |
Represents Sheet Email object used for sending a sheet by email.
|
| SheetEmail.AddSheetEmailBuilder |
A convenience class to help create a SheetEmail object with the appropriate fields.
|
| SheetEmailFormat |
Represents the Sheet email format.
|
| SheetFilter |
|
| SheetFilterDetails |
|
| SheetFilterOperator |
|
| SheetFilterResources |
|
| SheetFilterType |
|
| SheetInclusion |
Represents specific objects that can be included in some responses.
|
| SheetPublish |
Represents the publish status of a sheet.
|
| SheetPublish.PublishStatusBuilder |
A convenience class for making a SheetPublish object with the necessary fields to publish a sheet. |
| SheetResources |
This interface provides methods to access Sheet resources.
|
| SheetRowResources |
This interface provides methods to access row resources that are associated to a sheet object.
|
| SheetSummary |
|
| SheetSummaryResources |
|
| SheetTemplateInclusion |
Represents specific objects that can be included in some responses.
|
| SheetUpdateRequestResources |
|
| SheetUserPermissions |
|
| SheetUserSettings |
|
| SheetUserSettings.AddUserSettingsBuilder |
The Class AddUserSettingsBuilder.
|
| ShortcutDataItem |
|
| ShortcutWidgetContent |
|
| Sight |
|
| SightInclusion |
Represents specific objects that can be included in some responses.
|
| SightPublish |
|
| SightResources |
|
| 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.
|
| SmartsheetBuilder |
A convenience class to help create a Smartsheet instance with the appropriate fields. |
| SmartsheetException |
This is the base class for all exceptions thrown from the Smartsheet SDK.
|
| SmartsheetFactory |
|
| SmartsheetRestException |
This is the exception to indicate errors (Error objects of Smartsheet REST API) returned from Smartsheet REST API.
|
| SortCriterion |
|
| SortDirection |
|
| SortSpecifier |
|
| Source |
|
| SourceExclusion |
Represents specific objects that can be excluded in some responses.
|
| SourceInclusion |
Represents specific objects that can be included in some responses.
|
| SourceType |
|
| Strikethrough |
An enumeration representing the available Strikethrough state for a format.
|
| StringObjectValue |
|
| SummaryField |
|
| SummaryFieldExclusion |
|
| SummaryFieldInclusion |
|
| Symbol |
Represents the column symbols.
|
| SystemColumnType |
Represents the system column types.
|
| Template |
A template object that is a default layout for future sheets.
|
| TemplateResources |
This interface provides methods to access Template resources.
|
| TextWrap |
An enumeration representing the available text wrap settings within Smartsheet.
|
| ThousandsSeparator |
An enumeration representing the state of the Thousands separator.
|
| TitleRichTextWidgetContent |
|
| Token |
Represents OAuth token.
|
| TokenPaginatedResult<T> |
Represents a generic token-based paginated result that can contain any type of data.
|
| TokenResources |
|
| Trace |
this enum is used to control what from the HTTP request and response is logged
|
| Underline |
An enumeration representing the available Underline state for a format.
|
| UnsupportedOAuthGrantTypeException |
This is the exception thrown by OAuthFlow to indicate "unsupported_grant_type" error occurred during obtaining OAuth
tokens. |
| UnsupportedResponseTypeException |
This is the exception thrown by OAuthFlow to indicate "unsupported_response_type" error occurred when obtaining
an authorization code. |
| UpdateRequest |
Represents the UpdateRequest object.
|
| UpdateRequestStatus |
|
| UpdateShareRequest |
Represents an UpdateShareRequest object in the Smartsheet API.
|
| UpdateShareRequest.UpdateShareRequestBuilder |
|
| UpgradeSeatType |
|
| User |
Represents the User object.
|
| User.AddUserBuilder |
A convenience class for making a User object with the appropriate fields for adding the user. |
| User.NewGroupMemberBuilder |
A convenience class for making a GroupMember object with the appropriate fields for adding to a Group. |
| User.UpdateUserBuilder |
A convenience class for making a User object with the appropriate fields for updating a user. |
| UserInclusion |
Represents specific objects that can be included with the GetCurrentUser request.
|
| UserModel |
|
| UserModelWithName |
Represents the User Model object with name.
|
| UserPlan |
Represents the UserPlan object.
|
| UserProfile |
A profile object that contains the basic fields that most profiles will contain.
|
| UserResources |
This interface provides methods to access User resources.
|
| UserStatus |
Represents the user status.
|
| VerticalAlignment |
An enumeration representing the available vertical alignments within Smartsheet.
|
| WebContentWidgetContent |
|
| Webhook |
|
| WebhookResources |
|
| WebhookSharedSecret |
|
| WebhookStats |
|
| WebhookStatus |
|
| WebhookSubscope |
|
| Widget |
|
| WidgetContent |
|
| WidgetHyperlink |
|
| WidgetType |
|
| Workspace |
Represents the Workspace object which is an area in which sheets, reports, templates and sub-folders can be
organized, similar to a folder.
|
| Workspace.UpdateWorkspaceBuilder |
A convenience class for creating a Workspace object with the appropriate fields for updating a workspace. |
| WorkspaceCopyInclusion |
Represents specific objects that can be included in some responses.
|
| WorkspaceFolderResources |
T
|
| WorkspaceRemapExclusion |
Represents specific objects should be excluded in some responses.
|
| WorkspaceResources |
This interface provides methods to access Workspace resources.
|