Messaging - Revision history

Andyjdavis: Replaced content with "This document was replaced by Message_API"

2012-01-12T09:29:52Z

Replaced content with "This document was replaced by Message_API"

← Older revision		Revision as of 09:29, 12 January 2012
Line 1:		Line 1:
	The Messageing API is a new core system in Moodle to allow communication of messages to users. It's based on the events system, so a module will trigger an event with the attached message data and the message output processor will try to deliver the message to the correct place.		This document was replaced by [[Message_API]]

	~~==Overview==~~


	~~===Setting up a provider===~~
	* db/messages.php (list the types of providers)
	* /lang/XX/messages/providercomponent_providername.html (documentation)
	~~...~~

	~~===Setting up a processor===~~

	~~===Sending a Message===~~

	~~Whenever you need to send a message, it should “tell” the system about it. So, using the message as an example, we first define an object as follows:~~

	~~$eventdata = new object();~~
	~~$eventdata->component = "message";~~
	~~$eventdata->name = "instantmessage";~~
	~~$eventdata->userfrom = $userfrom;~~
	~~$eventdata->userto = $userto;~~
	~~$eventdata->subject = "IM";~~
	~~$eventdata->fullmessage = $message;~~
	~~$eventdata->fullmessageformat = FORMAT_PLAIN;~~
	~~$eventdata->fullmessagehtml = "";~~
	~~$eventdata->smallmessage = "";~~

	~~Then we post the object as an event and forget about it:~~

	~~events_trigger('message_send', $eventdata);~~

Lfrodrigues: /* Sending a Message */

2008-09-25T17:42:34Z

Sending a Message

← Older revision		Revision as of 17:42, 25 September 2008
Line 16:		Line 16:

	$eventdata = new object();		$eventdata = new object();
	$eventdata->component = 'message';		$eventdata->component = "message";
	$eventdata->name = 'instantmessage';		$eventdata->name = "instantmessage";
	$eventdata->userfrom = $userfrom;		$eventdata->userfrom = $userfrom;
	$eventdata->userto = $userto;		$eventdata->userto = $userto;
Line 23:		Line 23:
	$eventdata->fullmessage = $message;		$eventdata->fullmessage = $message;
	$eventdata->fullmessageformat = FORMAT_PLAIN;		$eventdata->fullmessageformat = FORMAT_PLAIN;
	$eventdata->fullmessagehtml = '';		$eventdata->fullmessagehtml = "";
	$eventdata->smallmessage = '';		$eventdata->smallmessage = "";

	Then we post the object as an event and forget about it:		Then we post the object as an event and forget about it:

	events_trigger('message_send', $eventdata);		events_trigger('message_send', $eventdata);

Lfrodrigues at 17:41, 25 September 2008

2008-09-25T17:41:57Z

@@ Line 4: / Line 4: @@
-==Files to Create==
+===Setting up a provider===
-/db/messages.php (list the types of providers)
+* db/messages.php (list the types of providers)
-/lang/XX/messages/providercomponent_providername.html (documentation)
+* /lang/XX/messages/providercomponent_providername.html (documentation)
 ...

Lfrodrigues at 16:31, 25 September 2008

2008-09-25T16:31:02Z

← Older revision		Revision as of 16:31, 25 September 2008
Line 1:		Line 1:
	The Messageing API is a new core system in Moodle to allow communication of messages to users. It's based on the events system, so a module will trigger an event with the attached message data and the message output processor will try to deliver the message to the correct place.		The Messageing API is a new core system in Moodle to allow communication of messages to users. It's based on the events system, so a module will trigger an event with the attached message data and the message output processor will try to deliver the message to the correct place.

			==Overview==


			==Files to Create==
			/db/messages.php (list the types of providers)
			/lang/XX/messages/providercomponent_providername.html (documentation)
			...

Lfrodrigues: New page: The Messageing API is a new core system in Moodle to allow communication of messages to users. It's based on the events system, so a module will trigger an event with the attached message ...

2008-09-25T13:30:32Z

New page: The Messageing API is a new core system in Moodle to allow communication of messages to users. It's based on the events system, so a module will trigger an event with the attached message ...

New page

The Messageing API is a new core system in Moodle to allow communication of messages to users. It's based on the events system, so a module will trigger an event with the attached message data and the message output processor will try to deliver the message to the correct place.