MultimediaChannel.getList (Method)
Returns a query describing the channels for the requested multimedia service.
Returns:
MultimediaChannel_GetList_Results (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| CanAdmin | Boolean | Boolean flag which when set to true indicates that the current user has 'Admin' rights on the channel. |
| CanManageMedia | Boolean | Boolean flag which when set to true indicates that the current user has 'ManageMedia' rights on the channel. |
| CanUse | Boolean | Boolean flag which when set to true indicates that the current user has 'Use' rights on the channel. |
| ChannelID | MultimediaChannelID | The unique ID of the channel. |
| ChannelIsActive | Boolean | Boolean flag reflecting if the channel is active. |
| ConfigurationState | Boolean | A Boolean flag reflecting if the channel is configured (ready for uploads). |
| Description | PlainText_2000 | The channel's description. |
| FileCount | NonNegativeInteger | The count of multimedia files under this channel. |
| IsExternal | Boolean | Boolean flag that determines if this channel belongs to an external service. |
| Name | PlainText_NonNull_255 | The name of the channel. |
| PlayersCount | NonNegativeInteger | The count of players under this channel. |
| PlaylistCount | NonNegativeInteger | The count of playlists under this channel. |
| ServiceID | MultimediaServiceID | The ID of the service. |
| ServiceName | PlainText_NonNull_255 | The name of the service. |
| ServicesIconURL | ServerRelativeURL_EmptyString | A server relative URL to an icon representing the service. |
| SupportsPlaylists | Boolean | Boolean flag that determines if this channel is created in a service that supports playlists. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| serviceID | MultimediaServiceID_0 | Optional. Defaults to '0'. | The ID of the multimedia service to filter by, or 0 to return all channels for all multimedia services. |
| activeFilter | ActiveFilter | Optional. Defaults to 'All'. | Flag to determine if the configurationState=0 channels should be included in the results. |
| playlistSupportingChannelsOnly | Boolean | Optional. Defaults to '0'. | If true, only channels that support playlists are returned. |
| permissionsToCheck | MultimediaChannelPermissionList_EmptyString | Optional. Defaults to an empty string. | A comma delimited list of permissions to check for the current user on a channel or empty string to return all the channels. |
| orderBy | SQLOrderByClause | Optional. Defaults to 'Name ASC'. | The SQL 'order by' clause indicating which column is used as the returned data's sort key. |
| getUpdatedStatus | Boolean | Optional. Defaults to '0'. | Boolean flag when true, we will check the configuration state of the channel by making a request to the channel with provided credentials. |
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