Multimedia.saveMetadata (Method)
Saves Multimedia Gallery record, standard metadata and the external reference ID returned by the external multimedia service if the service is external service.
Returns:
Boolean
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| multimediaID | MultimediaID | Required | ID of the multimedia file saved in sitepages table. |
| channelID | MultimediaChannelID | Required | ID of the multimedia channel. |
| subsiteIDOrURL | SubsiteIDorURL_EmptyString | Required | The ID of the target subsite, or the server relative path to the target subsite, or an empty string for the current subsite. |
| categoryID | DocumentCategoryID | Required | The unique ID of the category to classify the multimedia file against. |
| description | PlainText_2000 | Optional. Defaults to an empty string. | An optional description of the multimedia asset. |
| fileName | Filename_EmptyString | Optional. Defaults to an empty string. | File name of the multimedia file being uploaded. |
| fileExtension | Extension_EmptyString | Optional. Defaults to an empty string. | Extension of the file. |
| fileSize | NonNegativeLongInteger | Optional. Defaults to '0'. | Size of the file. |
| isPublic | Boolean | Optional. Defaults to '0'. | A boolean flag which when set to true indicates that the multimedia asset is public to other contributors. |
| externalRefID | MultimediaReferenceID_EmptyString | Optional. Defaults to an empty string. | Reference ID assigned by external service to a multimedia file. Empty string if there is none. |
| commonspotRefID | MultimediaReferenceID_EmptyString | Optional. Defaults to an empty string. | CommonSpot reference ID stored at external service for a Multimedia File or a Multimedia Playlist. |
| properties | Struct | Optional. Defaults to '#StructNew()#'. | Service specific fields for this multimedia file. |
| getMediaInfoFromService | Boolean | Optional. Defaults to '1'. | When true, get the media file details from the external service. |
| objectMedata | Any | Optional. Defaults to an empty string. | If we are importing data from external service, the data is passed in this structure. |
| status | MultimediaFileUploadStatus | Optional. Defaults to '1'. | Status of the multimedia file upload. Defaults to 1 as complete in normal upload process. But set to 7 (Pending Import) when imported using Import tool until the Metadata for the Multimedia File is entered by going to the Pending Multimedia Files dialog in the Dashboard. |
Context:
| License Requirements | (none) |
| Permission Requirements | ContributorOrServerCode |
| Deny Context | (none) |
| Require Context | AuthoringEnabled |
| Author Lock | (not required) |
| Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
| Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None