channels.getChannelTree

Syntax

array channels.getChannelTree ( int vhost, mixed order = '', mixed visibility = 'ALL', mixed removeEmptyChildNodes = 0 )

Argument Info

NameTypeRequiredDefault valueDescription
vhostintRequirednone
ordermixedOptional''
visibilitymixedOptional'ALL'
removeEmptyChildNodesmixedOptional0

Return Values

FieldDescriptionPossible Values
idachannel idbN/A
nameachannelnamebN/A
createdacreationdatebN/A
groupidathe id of the parent channel, if any (depreciated)bN/A
groupnameathe name of the parent channel (deprecated)bN/A
parentchannelathe id of the parent channel, if anybN/A
descriptionadescription for the channelbN/A
geoblockingaeach item is a country code that is allowed to view the media item, if empty then all countries may view the mediabN/A
childrenaarray with sub-channels. If there are no subchannels, this will be emptybN/A
visibilitya"SHOWN" or "HIDDEN"bN/A