MultimediaChannel.update (Method)
Updates an existing multimedia service channel.
Returns:
MultimediaChannelID (integer)
Arguments:
Name | Type | Required | Description |
---|---|---|---|
channelID | MultimediaChannelID | Required | The ID of the multimedia channel to update. |
serviceID | MultimediaServiceID | Required | The unique ID of the multimedia service. |
name | PlainText_NonNull_100 | Required | The name of the multimedia channel. |
description | PlainText_2000 | Required | A description of the multimedia channel. |
isActive | Boolean | Required | Boolean value indicating if this channel is active or not. |
properties | Struct | Optional. Defaults to '#StructNew()#'. | An array of property field structures that define the values for the multimedia service. |
maximumSize | NonNegativeInteger | Optional. Defaults to '0'. | Maximum size of multimedia file in megabytes. 0 for no limit. |
supportedFormats | PlainText_255 | Optional. Defaults to an empty string. | Comma delimited list of multimedia file formats supported by this multimedia service. Empty string means no file type restrictions. |
Context:
License Requirements | (none) |
Permission Requirements | multimediaChannel:Admin |
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:
Code | Error Message |
---|---|
403 | |
409 | |
82512 | Invalid Channel or Service. |
82550 | A multimedia channel with this name already exists for this service. |
Notes:
None