MultimediaChannel.getInfo (Method)
Returns a structure describing the multimedia channel.
Returns:
MultimediaChannel_GetInfo_Struct (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| ChannelID | MultimediaChannelID | The unique ID of the multimedia channel. |
| ChannelIsActive | Boolean | Boolean flag reflecting if the channel is active. |
| ConfigurationState | Boolean | Boolean flag reflecting if the channel has been configured (ready for uploads). |
| Description | PlainText_2000 | The channel's description. |
| IsExternal | Boolean | Boolean flag that tells if the channel belongs to an external multimedia service. |
| MaximumSize | NonNegativeInteger | Maximum file size in megabytes. 0 for no limit. |
| Name | PlainText_NonNull_100 | The name of the multimedia channel. |
| ServiceID | MultimediaServiceID | The ID of the multimedia service. |
| ServiceName | PlainText_NonNull_100 | The name of the multimedia service. |
| ServicesIconURL | ServerRelativeURL_EmptyString | A server relative URL to an icon representing the multimedia service. |
| SupportedFormats | FileFormatList | Comma delimited list of file formats supported by this channel. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| channelID | MultimediaChannelID | Required | The unique ID of the multimedia channel to return information for. |
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 | Customization is not supported for this method. |
Error Codes:
None
Notes:
None