fm:EventList allows you to create a list of events stored within the system.
| Name | Required | Default | Description |
|---|
| creatorUserID | Optional | N/A | Only return groups that were created by the given user ID |
| custom1 | Optional | N/A | Only return groups that have the given string as their custom1 value |
| endAfter | Optional | none | A date and time that the returned events must end after |
| endBefore | Optional | none | A date and time that the returned events must end before |
| evenClass | Optional | | The contents of this attribute will be placed in the 'loop.evenClass' template variable, only for even row-numbers. This allows you to give every even row a specific css class |
| includeChildren | Optional | 0 | Return all levels of children of the specified parent group instead of only its direct descendants. May only be used in combination with the parentGroup attribute. |
| mediaID | Optional | N/A | Only return groups that contain the given media |
| moderationStatus | Optional | N/A | Filter by this moderationstatus. Possible values are "accepted", "denied", "unmoderated", "moderated", "notdenied","all" |
| oddClass | Optional | | The contents of this attribute will be placed in the 'loop.oddClass' template variable, only for odd row-numbers. This allows you to give every odd row a specific css class |
| pageSize | Optional | 100 | Sets the total number of items per page. |
| parentGroup | Optional | (empty) | Groups support nesting, you can display all sub-groups for a specific parent-group by specifying the ID using this attribute. Specifying 0 indicates you only want the top-level groups. An empty value is the default and indicates that no filtering based on the parent group will be applied. |
| searchDescription | Optional | N/A | Only return groups that have the given string in their description |
| searchName | Optional | N/A | Only return groups that have the given string in their name |
| searchQuery | Optional | N/A | Searches using the full-text index on title, description, address and city |
| sort | Optional | created DESC | Sets the sort field. Use the format fieldname ASC/DESC. Currently created, membercount, mediacount, id, approvedmediacount, notdeniedmediacount, name, startdate, enddate, and treeleft are supported. To retrieve the groups in the same order they are in the group-event tree use "treeleft ASC". |
| startAfter | Optional | none | A date and time that the returned events must start after |
| startBefore | Optional | none | A date and time that the returned events must start before |
| startPage | Optional | 0 | Sets the startpage for this list. |
| uid | Optional | N/A | Only return groups that the given user ID is a member of |
| Name | Description |
|---|
| loop.hasResults | The contents of this variable will be either 0 or 1, depending on if there are items in the list. |
| loop.oddClass | The contents of this variable will reflect the "oddClass" attribute. This will only be set for odd rownumbers. |
| loop.evenClass | The contents of this variable will reflect the "evenClass" attribute. This will only be set for even rownumbers. |
| loop.index | The 0-based index of the item in the loop. (Will contain 0,1,2,3,4, etc.) |
| loop.count | The count of the current item in the loop. (Will contain 1,2,3,4,5 etc.) |
| loop.currentPage | If a pager is involved in this loop, this will contain the current page number (0-based index). If page information is not available, this will be 0. |
| loop.currentPage1 | This value is currentPage + 1. This number can be useful to display the current page number to use user. (people generally count from 1, not 0). |
| loop.totalPages | Total number of pages avaiable in this loop. This will be 0 if the loop does not support paging. |
| loop.totalItems | Total number of individual items. This will be 0 if the loop does not support paging. |
| loop.pageSize | Total number of items on 1 single page. This will be 0 if the loop does not support paging. |
| group.id | Group id |
| group.name | Group name |
| group.description | Description |
| group.note | The note field can be used to specify additional information about the group, generally this is only used within the mediafactory |
| group.logo | The logo is actually a media-id, use this in conjunction with the mediaviewers. |
| group.thumbUrl | The thumb URL of the logo. |
| group.publicUrl | The publiuc URL of the logo. |
| group.created | The creation date in YYYY-MM-DD HH:MM:SS format |
| group.createdby | This is a user-id |
| group.parentGroup | This is the id of the group's parent |
| group.memberCount | This variable contains the total number of group members |
| group.mediaCount | This variable contains the total number of items associated with the group |
| group.approvedMediaCount | This variable contains the number of media items associated with the group that have been approved |
| group.notDeniedMediaCount | This variable contains the number of media items associated with the group that have not been denied |
| group.geo_longitude | The longitude of the group. |
| group.geo_latitude | The latitude of the group. |
| group.moderationStatus | The current moderation-status for the group. This can be either unmoderated, accepted or denied |
| group.address | Address of the group. |
| group.city | City the group is in. |
| group.state | 2-letter state or province |
| group.postalcode | Postal/zip-code |
| group.country | 2-letter country code |
| group.custom1 | A string of custom text, maximum 32 characters long |
| startDate | The start date of the event |
| endDate | The end date of the event |
developer documentation r21536