object lists( params )

Description:

This will return a page-able list of list objects.

Parameters:

params

possible keys:

status - search by status. valid values are: enabled, disabled, all (enabled or disabled). defaults to "enabled" only

limit - the amount of lists to return

sort - an array in the format of:

'field' => 'direction'

example: "name" => "DESC"

multiple sorts are done in the order defined

possible sort fields: name, createtime, status, deletetime

displayed - search for lists that are displayed on user signup

name - search by list name. wildcards are applied already, so do not use them

description - search by description. wildcards are applied already, so do not use them

author - search for lists created by a certain user (uuid)

createtime - array in the format of:

'createtime' => array( 'from' => '2012-12-01 00:00:00', 'to' => 'today' )

where 'from' and 'to' are both values that can be parsed by php's DateTime object. the combined values are used as a range. if one is not passed, then it means the range is open-ended in one direction.

business - get lists that are associated with this specific business uuid.

Return:

returns TNCMS_Template_Adapter_Iterator object