channels.getChannels

Syntax

array channels.getChannels ( int vhost, mixed order = false, mixed visibility = 'ALL', int parentchannel = 0 )

Argument Info

Name	Type	Required	Default value	Description
vhost	int	Required	none	The vhost ID that the list of channels belong to in MediaFactory.
order	mixed	Optional	false	The order in which you wish to have the channel list returned to you in.
visibility	mixed	Optional	'ALL'	The visibility of the channel you want to filter on for the returned list of channels.
parentchannel	int	Optional	0	If set - the component returns only channels that are children of the given channel.

Return Values

Field	Description	Possible Values
ida	channel idb	this is some copyc
namea	channelnameb	N/A
createda	creationdateb	N/A
groupida	the id of the parent channel, if any (depreciated)b	N/A
groupnamea	the name of the parent channel (deprecated)b	N/A
parentchannela	the id of the parent channel, if anyb	N/A
descriptiona	description for the channelb	N/A
geoblockinga	each item is a country code that is allowed to view the media item, if empty then all countries may view the mediab	N/A
visibilitya	"SHOWN" or "HIDDEN". Hiding a channel does not make the media within private, hidden or otherwise inaccessible.b	N/A