RSS API: Difference between revisions

Revision as of 05:44, 16 January 2012

The RSS API is a core system in Moodle to allow you to create secure RSS feeds of data in your module.

These RSS feeds can then be syndicated by other websites or aggregated by a feed reader.

Any Moodle module can generate RSS feeds to allow secure access to it's data.

Below you will find examples on how to use the RSS functions within your own modules.

Field	Type	Info
id	int(10)	auto increment identifier
queuedeventid	int(10)	foreign key id corresponding to the id of the event_queues table
handlerid	int(10)	foreign key id corresponding to the id of the event_handlers table
status	int(10)	number of failed attempts to process this handler
errormessage	text	if an error happened last time we tried to process this event, record it here.
timemodified	int(10)	time stamp of the last attempt to run this from the queue

@@ Line 1: / Line 1: @@
 ==Overview==
-The Events API is a core system in Moodle to allow communication between modules.
+The RSS API is a core system in Moodle to allow you to create secure RSS feeds of data in your module.
-An '''event''' is when something "interesting" happens in Moodle that is worth alerting the system about.
+These RSS feeds can then be syndicated by other websites or aggregated by a feed reader.
-Any Moodle modules can '''trigger''' new events (with attached data), and other modules can elect to '''handle''' those events with custom functions that operate on the given data.
+Any Moodle module can generate RSS feeds to allow secure access to it's data.