| Package | Description |
|---|---|
| com.smartsheet.api | |
| com.smartsheet.api.models |
| Modifier and Type | Method and Description |
|---|---|
Result<SummaryField> |
SheetSummaryResources.addSheetSummaryFieldImage(long sheetId,
long fieldId,
String file,
String contentType,
String altText)
Adds an image to the sheet summary field.
|
List<SummaryField> |
SheetSummaryResources.addSheetSummaryFields(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Insert fields into a sheet summary.
|
BulkItemResult<SummaryField> |
SheetSummaryResources.addSheetSummaryFieldsWithPartialSuccess(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Insert fields into a sheet summary.
|
PagedResult<SummaryField> |
SheetSummaryResources.getSheetSummaryFields(long sheetId,
EnumSet<SummaryFieldInclusion> includes,
EnumSet<SummaryFieldExclusion> excludes,
PaginationParameters pagination)
Gets the sheet summary fields
|
List<SummaryField> |
SheetSummaryResources.updateSheetSummaryFields(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Update fields in a sheet summary.
|
BulkItemResult<SummaryField> |
SheetSummaryResources.updateSheetSummaryFieldsWithPartialSuccess(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Update fields in a sheet summary.
|
| Modifier and Type | Method and Description |
|---|---|
List<SummaryField> |
SheetSummaryResources.addSheetSummaryFields(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Insert fields into a sheet summary.
|
BulkItemResult<SummaryField> |
SheetSummaryResources.addSheetSummaryFieldsWithPartialSuccess(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Insert fields into a sheet summary.
|
List<SummaryField> |
SheetSummaryResources.updateSheetSummaryFields(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Update fields in a sheet summary.
|
BulkItemResult<SummaryField> |
SheetSummaryResources.updateSheetSummaryFieldsWithPartialSuccess(long sheetId,
List<SummaryField> fields,
Boolean renameIfConflict)
Update fields in a sheet summary.
|
| Modifier and Type | Method and Description |
|---|---|
SummaryField |
SummaryField.setContactOptions(List<Contact> contactOptions)
Set contact options
|
SummaryField |
SummaryField.setCreatedAt(Date createdAt)
Set summary field time of creation
|
SummaryField |
SummaryField.setCreatedBy(User createdBy)
Set User object of summary field creator
|
SummaryField |
SummaryField.setDisplayValue(String displayValue)
Sets the display value of the summary field
|
SummaryField |
SummaryField.setFormat(Format format)
Sets the format descriptor
|
SummaryField |
SummaryField.setFormula(String formula)
Sets the formula for the summary field
|
SummaryField |
SummaryField.setHyperlink(Hyperlink hyperlink)
Sets the hyperlink associated with the field
|
SummaryField |
SummaryField.setImage(Image image)
Sets the image associated with the field
|
SummaryField |
SummaryField.setIndex(Integer index)
Sets the field index or position
|
SummaryField |
SummaryField.setLocked(Boolean locked)
Sets flag indicating if field is locked
|
SummaryField |
SummaryField.setLockedForUser(Boolean lockedForUser)
Sets flag indicating whether field is locked for the requesting user
|
SummaryField |
SummaryField.setModifiedAt(Date modifiedAt)
Sets the last modification date and time
|
SummaryField |
SummaryField.setModifiedBy(User modifiedBy)
Sets the User who last modified the field
|
SummaryField |
SummaryField.setObjectValue(ObjectValue objectValue)
Sets the field's objectValue
|
SummaryField |
SummaryField.setOptions(List<String> options)
Sets PICKLIST options
|
SummaryField |
SummaryField.setSymbol(String symbol)
Sets applicable symbo for PICKLIST type
|
SummaryField |
SummaryField.setTitle(String title)
Sets the field's title
|
SummaryField |
SummaryField.setType(ColumnType type)
Sets the field's type - see Column Type
|
SummaryField |
SummaryField.setValidation(Boolean validation)
Sets flag indicating whether summary field values are restricted to type
|
| Modifier and Type | Method and Description |
|---|---|
List<SummaryField> |
SheetSummary.getFields()
Get sheet summary fields
|
| Modifier and Type | Method and Description |
|---|---|
SheetSummary |
SheetSummary.setFields(List<SummaryField> fields)
Set sheet summary fields
|
Copyright © 2014–2019 Smartsheet. All rights reserved.