Image.getVersionList (Method)
Returns one or more structures, each containing information about an image's versions; for example, the image's description, file name, version time stamp, and so on.
Returns:
Image_GetVersionList_Result (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
Description | PlainText_2000 | The version's description. |
Extension | Extension | The image's extension. |
FileName | Filename | The image's file name. |
FileSize | NonNegativeInteger | The image's byte size. |
GalleryID | ImageGalleryID | ID of the image gallery in which the image resides. |
GalleryName | PlainText_NonNull_125 | Name of the image gallery in which the image resides. |
GalleryWebPRenderFlag | Boolean | Boolean flag indicating if webP rendering is enabled or not. |
OrgHeight | NonNegativeInteger | The image's original height in pixels. |
OrgWidth | NonNegativeInteger | The image's original width pixels. |
ServerFile | Filename_EmptyString | The image server file name. |
SubSiteID | SubsiteID | The image's subsite ID. |
SubsiteURL | ServerRelativeURL | The server-relative URL of the image's subsite. |
ThumbnailImageURL | ServerRelativeURL_EmptyString | The URL to the image's thumbnail representation. |
VersionTimestamp | PastTimestamp | The date and time when the version was created. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
imageID | ImageID | Required | An image's ID. |
thumbnailFormat | AlternateImageFormat_EmptyString | Optional. Defaults to an empty string. | The alternate image format. If this is an empty string, the alternate format is ''thumbnailimageurl'. Otherwise, CommonSpot returns the URL to the alternate format. |
Context:
License Requirements | None |
Permission Requirements | ContributorOrServerCode |
Deny Context | None |
Require Context | None |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | This method may be customized at the site level |
Error Codes:
None
Notes:
None