Message API - Revision history

Devdocsbot: Protected "Message API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

2023-09-18T11:52:46Z

Protected "Message API": Developer Docs Migration ([Edit=Allow only administrators] (indefinite))

← Older revision	Revision as of 11:52, 18 September 2023
(No difference)

Devdocsbot: Update migration status and path

2023-09-18T11:49:59Z

Update migration status and path

Show changes

Mudrd8mz: Text replacement - "`" to ""`


2021-07-15T08:10:13Z
Text replacement - "<code (.*)>" to "<syntaxhighlight lang="$1">"

				
				
				
				
				
				← Older revision
				Revision as of 08:10, 15 July 2021
				
Line 172:
Line 172:
The database tables have changed. Messages from Moodle components to a user (e.g. mod_quiz), telling them that something has happened (e.g. an attempt was submitted) have always been 'Notifications'. In the past, this was just a column in the mdl_message table. Now, messages and notifications are stored in completely separate tables. Notifications are in mdl_notifications. The strucutre of this table is very similar to the old mdl_message table which is now not used at all. Messages are in mdl_messages, and related tables, that now exist to support group messaging. Those tables join together like this: The database tables have changed. Messages from Moodle components to a user (e.g. mod_quiz), telling them that something has happened (e.g. an attempt was submitted) have always been 'Notifications'. In the past, this was just a column in the mdl_message table. Now, messages and notifications are stored in completely separate tables. Notifications are in mdl_notifications. The strucutre of this table is very similar to the old mdl_message table which is now not used at all. Messages are in mdl_messages, and related tables, that now exist to support group messaging. Those tables join together like this:



<code sql> <syntaxhighlight lang="sql">
SELECT * SELECT *



Mudrd8mz: Text replacement - "" to ""

2021-07-14T13:35:30Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:35, 14 July 2021
				
Line 32:
Line 32:



The messages produced by a message provider is defined in the /db/messages.php file of a component. Below is code from the quiz module's messages.php file, shown as an example. The messages produced by a message provider is defined in the /db/messages.php file of a component. Below is code from the quiz module's messages.php file, shown as an example.
<code php> <syntaxhighlight lang="php">
defined('MOODLE_INTERNAL') || die(); defined('MOODLE_INTERNAL') || die();
$messageproviders = array ( $messageproviders = array (
Line 48:
Line 48:
The quiz can send two kinds of messages, quiz "submission" and "confirmation" notifications. Each message type is only available to users with the appropriate capability. Please note that the capability is checked at the system level context. Users who have this capability will have this message listed in their messaging preferences. You can omit the capability section if your message should be visible for all users. For example forum post notifications are available to all users. The quiz can send two kinds of messages, quiz "submission" and "confirmation" notifications. Each message type is only available to users with the appropriate capability. Please note that the capability is checked at the system level context. Users who have this capability will have this message listed in their messaging preferences. You can omit the capability section if your message should be visible for all users. For example forum post notifications are available to all users.



<code php> <syntaxhighlight lang="php">
$messageproviders = array ( $messageproviders = array (
     // Ordinary single forum posts      // Ordinary single forum posts
Line 57:
Line 57:



When displaying your message types in a user's messaging preferences it will use a string from your component's language file called "messageprovider:messagename". For example here are the relevant strings from the quiz's language file. When displaying your message types in a user's messaging preferences it will use a string from your component's language file called "messageprovider:messagename". For example here are the relevant strings from the quiz's language file.
<code php> <syntaxhighlight lang="php">
$string['messageprovider:confirmation'] = 'Confirmation of your own quiz submissions'; $string['messageprovider:confirmation'] = 'Confirmation of your own quiz submissions';
$string['messageprovider:submission'] = 'Notification of quiz submissions'; $string['messageprovider:submission'] = 'Notification of quiz submissions';
Line 66:
Line 66:
The default processor can be set using an element of the array   The default processor can be set using an element of the array  
e.g. e.g.
<code php> <syntaxhighlight lang="php">
  'mynotification' => [   'mynotification' => [
          'defaults' => [           'defaults' => [
Line 76:
Line 76:
With that setting email will be permitted but disabled for each user by default. It  can be turned on by each user through the preferences/notification preferences options (/message/notificationpreferences.php?userid=X) With that setting email will be permitted but disabled for each user by default. It  can be turned on by each user through the preferences/notification preferences options (/message/notificationpreferences.php?userid=X)
The possible values are recorded in the lib.php file of messaging The possible values are recorded in the lib.php file of messaging
<code php> <syntaxhighlight lang="php">
/** /**
  * Define contants for messaging default settings population. For unambiguity of   * Define contants for messaging default settings population. For unambiguity of
Line 92:
Line 92:
{{Moodle_2.9}} {{Moodle_2.9}}
Here is example code showing you how to actually send a notification message. The example shows the construction of a object with specific properties, which is then passed to the message_send() function that uses the information to send a message. Here is example code showing you how to actually send a notification message. The example shows the construction of a object with specific properties, which is then passed to the message_send() function that uses the information to send a message.
<code php> <syntaxhighlight lang="php">
$message = new \core\message\message(); $message = new \core\message\message();
$message->component = 'mod_yourmodule'; // Your plugin's name $message->component = 'mod_yourmodule'; // Your plugin's name
Line 130:
Line 130:
Before 2.9 message data used to be a stdClass object as shown below (This formation of a message will no longer work as of Moodle 3.6. Only a message object will be accepted):- Before 2.9 message data used to be a stdClass object as shown below (This formation of a message will no longer work as of Moodle 3.6. Only a message object will be accepted):-



<code php> <syntaxhighlight lang="php">
$message = new stdClass(); $message = new stdClass();
$message->component         = 'mod_quiz'; //your component name $message->component         = 'mod_quiz'; //your component name
Line 148:
Line 148:



Here is example code showing you how to set-up the Javascript popup link. Here is example code showing you how to set-up the Javascript popup link.
<code php> <syntaxhighlight lang="php">
require_once('message/lib.php'); require_once('message/lib.php');
$userid = 2; $userid = 2;



Mudrd8mz: Text replacement - "" to ""
2021-07-14T13:02:25Z
Text replacement - "</code>" to "</syntaxhighlight>"

				
				
				
				
				
				← Older revision
				Revision as of 13:02, 14 July 2021
				
Line 44:
Line 44:
     )      )
); );
</code> </syntaxhighlight>



The quiz can send two kinds of messages, quiz "submission" and "confirmation" notifications. Each message type is only available to users with the appropriate capability. Please note that the capability is checked at the system level context. Users who have this capability will have this message listed in their messaging preferences. You can omit the capability section if your message should be visible for all users. For example forum post notifications are available to all users. The quiz can send two kinds of messages, quiz "submission" and "confirmation" notifications. Each message type is only available to users with the appropriate capability. Please note that the capability is checked at the system level context. Users who have this capability will have this message listed in their messaging preferences. You can omit the capability section if your message should be visible for all users. For example forum post notifications are available to all users.
Line 54:
Line 54:
     )      )
); );
</code> </syntaxhighlight>



When displaying your message types in a user's messaging preferences it will use a string from your component's language file called "messageprovider:messagename". For example here are the relevant strings from the quiz's language file. When displaying your message types in a user's messaging preferences it will use a string from your component's language file called "messageprovider:messagename". For example here are the relevant strings from the quiz's language file.
Line 60:
Line 60:
$string['messageprovider:confirmation'] = 'Confirmation of your own quiz submissions'; $string['messageprovider:confirmation'] = 'Confirmation of your own quiz submissions';
$string['messageprovider:submission'] = 'Notification of quiz submissions'; $string['messageprovider:submission'] = 'Notification of quiz submissions';
</code> </syntaxhighlight>



Once your messages.php is complete you need to increase the version number of your component in its version.php. That will cause Moodle to check messages.php looking for new or changed message definitions. Log in as an admin and go to /admin/index.php (the Notifications page) to start the upgrade process. Once your messages.php is complete you need to increase the version number of your component in its version.php. That will cause Moodle to check messages.php looking for new or changed message definitions. Log in as an admin and go to /admin/index.php (the Notifications page) to start the upgrade process.
Line 73:
Line 73:
           ],            ],
     ],      ],
</code> </syntaxhighlight>
With that setting email will be permitted but disabled for each user by default. It  can be turned on by each user through the preferences/notification preferences options (/message/notificationpreferences.php?userid=X) With that setting email will be permitted but disabled for each user by default. It  can be turned on by each user through the preferences/notification preferences options (/message/notificationpreferences.php?userid=X)
The possible values are recorded in the lib.php file of messaging The possible values are recorded in the lib.php file of messaging
Line 86:
Line 86:
  * MESSAGE_PERMITTED_MASK contains the mask we use to distinguish permission setting   * MESSAGE_PERMITTED_MASK contains the mask we use to distinguish permission setting
  */   */
</code> </syntaxhighlight>
Note that if you change the values in message.php and then upgrade the plugin the values will not automatically be changed in the config_plugins table where they are stored. Note that if you change the values in message.php and then upgrade the plugin the values will not automatically be changed in the config_plugins table where they are stored.



Line 126:
Line 126:
// Actually send the message // Actually send the message
$messageid = message_send($message); $messageid = message_send($message);
</code> </syntaxhighlight>



Before 2.9 message data used to be a stdClass object as shown below (This formation of a message will no longer work as of Moodle 3.6. Only a message object will be accepted):- Before 2.9 message data used to be a stdClass object as shown below (This formation of a message will no longer work as of Moodle 3.6. Only a message object will be accepted):-
Line 143:
Line 143:
$message->notification      = 1; //this is only set to 0 for personal messages between users $message->notification      = 1; //this is only set to 0 for personal messages between users
message_send($message); message_send($message);
</code> </syntaxhighlight>



===How to set-up the message popup=== ===How to set-up the message popup===
Line 157:
Line 157:
$attributes = message_messenger_sendmessage_link_params($userto); $attributes = message_messenger_sendmessage_link_params($userto);
echo html_writer::link($url, 'Send a message', $attributes); echo html_writer::link($url, 'Send a message', $attributes);
</code> </syntaxhighlight>



==Changes in Moodle 3.5== ==Changes in Moodle 3.5==
Line 181:
Line 181:



ORDER BY m.timecreated, m.id, mem.userid, act.id ORDER BY m.timecreated, m.id, mem.userid, act.id
</code> </syntaxhighlight>



==See also== ==See also==



Plemaire: /* Changes in Moodle 3.5 */ very small correction
2021-06-26T13:08:35Z
Changes in Moodle 3.5:  very small correction

				
				
				
				
				
				← Older revision
				Revision as of 13:08, 26 June 2021
				
Line 164:
Line 164:
In Moodle 3.5, there were some moderately big changes. The only docs I have been able to find about them are in [https://github.com/moodle/moodle/blob/33a388eff737c049786ee42d7430db549568471c/message/upgrade.txt#L56 upgrade.txt] file. However, that is the details, here is an overview: In Moodle 3.5, there were some moderately big changes. The only docs I have been able to find about them are in [https://github.com/moodle/moodle/blob/33a388eff737c049786ee42d7430db549568471c/message/upgrade.txt#L56 upgrade.txt] file. However, that is the details, here is an overview:



The main message_send() API to send a message has not changed, so if yout code is just sending messages, you don't need to do anything. The main message_send() API to send a message has not changed, so if your code is just sending messages, you don't need to do anything.



Similarly, message_output plugins don't need to change, so no worries there. Similarly, message_output plugins don't need to change, so no worries there.



Quen: Changing the message send example to show how to actually send a notification from a plugin which is what this page is about...
2020-11-26T11:54:04Z
Changing the message send example to show how to actually send a notification from a plugin which is what this page is about...

				
				
				
				
				
				← Older revision
				Revision as of 11:54, 26 November 2020
				
Line 91:
Line 91:
===How to send a message=== ===How to send a message===
{{Moodle_2.9}} {{Moodle_2.9}}
Here is example code showing you how to actually send a message. The example shows the construction of a object with specific properties, which is then passed to the message_send() function that uses the information to send a message. Here is example code showing you how to actually send a notification message. The example shows the construction of a object with specific properties, which is then passed to the message_send() function that uses the information to send a message.
<code php> <code php>
$message = new \core\message\message(); $message = new \core\message\message();
$message->component = 'moodle'; $message->component = 'mod_yourmodule'; // Your plugin's name
$message->name = 'instantmessage'; $message->name = 'mynotification'; // Your notification name from message.php
$message->userfrom = $USER; $message->userfrom = core_user::get_noreply_user(); // If the message is 'from' a specific user you can set them here
$message->userto = $user; $message->userto = $user;
$message->subject = 'message subject 1'; $message->subject = 'message subject 1';
Line 103:
Line 103:
$message->fullmessagehtml = '<p>message body</p>'; $message->fullmessagehtml = '<p>message body</p>';
$message->smallmessage = 'small message'; $message->smallmessage = 'small message';
$message->notification = '0'; $message->notification = 1; // Because this is a notification generated from Moodle, not a user-to-user message
$message->contexturl = 'http://GalaxyFarFarAway.com'; $message->contexturl = (new \moodle_url('/course/'))->out(false); // A relevant URL for the notification
$message->contexturlname = 'Context name'; $message->contexturlname = 'Course list'; // Link title explaining where users get to for the contexturl
$message->replyto = "random@example.com"; 
$content = array('*' => array('header' => ' test ', 'footer' => ' test ')); // Extra content for specific processor $content = array('*' => array('header' => ' test ', 'footer' => ' test ')); // Extra content for specific processor
$message->set_additional_content('email', $content); $message->set_additional_content('email', $content);
$message->courseid = $course->id; // This is required in recent versions, use it from 3.2 on https://tracker.moodle.org/browse/MDL-47162 



// Create a file instance. // You probably don't need attachments but if you do, here is how to add one
$usercontext = context_user::instance($user->id); $usercontext = context_user::instance($user->id);
$file = new stdClass; $file = new stdClass;
Line 126:
Line 124:
$message->attachment = $file; $message->attachment = $file;



// Actually send the message
$messageid = message_send($message); $messageid = message_send($message);
</code> </code>



TimHunt at 13:36, 18 December 2018
2018-12-18T13:36:43Z


				
				
				
				
				
				← Older revision
				Revision as of 13:36, 18 December 2018
				
Line 158:
Line 158:
$attributes = message_messenger_sendmessage_link_params($userto); $attributes = message_messenger_sendmessage_link_params($userto);
echo html_writer::link($url, 'Send a message', $attributes); echo html_writer::link($url, 'Send a message', $attributes);
</code>

==Changes in Moodle 3.5==
{{Moodle_3.5}}

In Moodle 3.5, there were some moderately big changes. The only docs I have been able to find about them are in [https://github.com/moodle/moodle/blob/33a388eff737c049786ee42d7430db549568471c/message/upgrade.txt#L56 upgrade.txt] file. However, that is the details, here is an overview:

The main message_send() API to send a message has not changed, so if yout code is just sending messages, you don't need to do anything.

Similarly, message_output plugins don't need to change, so no worries there.

If you are doing things with messages, then you need to understand how the internals have changed.

The database tables have changed. Messages from Moodle components to a user (e.g. mod_quiz), telling them that something has happened (e.g. an attempt was submitted) have always been 'Notifications'. In the past, this was just a column in the mdl_message table. Now, messages and notifications are stored in completely separate tables. Notifications are in mdl_notifications. The strucutre of this table is very similar to the old mdl_message table which is now not used at all. Messages are in mdl_messages, and related tables, that now exist to support group messaging. Those tables join together like this:

<code sql>
SELECT *

FROM mdl_messages m
JOIN mdl_message_conversations con ON con.id = m.conversationid
JOIN mdl_message_conversation_members mem ON mem.conversationid = con.id
LEFT JOIN mdl_message_user_actions act ON act.userid = mem.userid AND act.messageid = m.id

ORDER BY m.timecreated, m.id, mem.userid, act.id
</code> </code>






Abgreeve: Deprecation of using a stdClass for creating a message mentioned.
2018-11-12T02:49:26Z
Deprecation of using a stdClass for creating a message mentioned.

				
				
				
				
				
				← Older revision
				Revision as of 02:49, 12 November 2018
				
Line 129:
Line 129:
</code> </code>



Before 2.9 message data used to be a stdClass object as shown below:- Before 2.9 message data used to be a stdClass object as shown below (This formation of a message will no longer work as of Moodle 3.6. Only a message object will be accepted):-



<code php> <code php>



Marcusgreen: /* Setting defaults */
2018-11-07T12:07:07Z
Setting defaults

				
				
				
				
				
				← Older revision
				Revision as of 12:07, 7 November 2018
				
Line 87:
Line 87:
  */   */
</code> </code>
Note that if you change the values in message.php and then upgrade the plugin the values will not automatically be changed in the config_plugins table. Note that if you change the values in message.php and then upgrade the plugin the values will not automatically be changed in the config_plugins table where they are stored.



===How to send a message=== ===How to send a message===

← Older revision		Revision as of 08:10, 15 July 2021
Line 172:		Line 172:
	The database tables have changed. Messages from Moodle components to a user (e.g. mod_quiz), telling them that something has happened (e.g. an attempt was submitted) have always been 'Notifications'. In the past, this was just a column in the mdl_message table. Now, messages and notifications are stored in completely separate tables. Notifications are in mdl_notifications. The strucutre of this table is very similar to the old mdl_message table which is now not used at all. Messages are in mdl_messages, and related tables, that now exist to support group messaging. Those tables join together like this:		The database tables have changed. Messages from Moodle components to a user (e.g. mod_quiz), telling them that something has happened (e.g. an attempt was submitted) have always been 'Notifications'. In the past, this was just a column in the mdl_message table. Now, messages and notifications are stored in completely separate tables. Notifications are in mdl_notifications. The strucutre of this table is very similar to the old mdl_message table which is now not used at all. Messages are in mdl_messages, and related tables, that now exist to support group messaging. Those tables join together like this:

	<~~code~~ sql>		<syntaxhighlight lang="sql">
	SELECT *		SELECT *

← Older revision		Revision as of 13:35, 14 July 2021
Line 32:		Line 32:

	The messages produced by a message provider is defined in the /db/messages.php file of a component. Below is code from the quiz module's messages.php file, shown as an example.		The messages produced by a message provider is defined in the /db/messages.php file of a component. Below is code from the quiz module's messages.php file, shown as an example.
	<~~code~~ php>		<syntaxhighlight lang="php">
	defined('MOODLE_INTERNAL') \|\| die();		defined('MOODLE_INTERNAL') \|\| die();
	$messageproviders = array (		$messageproviders = array (
Line 48:		Line 48:
	The quiz can send two kinds of messages, quiz "submission" and "confirmation" notifications. Each message type is only available to users with the appropriate capability. Please note that the capability is checked at the system level context. Users who have this capability will have this message listed in their messaging preferences. You can omit the capability section if your message should be visible for all users. For example forum post notifications are available to all users.		The quiz can send two kinds of messages, quiz "submission" and "confirmation" notifications. Each message type is only available to users with the appropriate capability. Please note that the capability is checked at the system level context. Users who have this capability will have this message listed in their messaging preferences. You can omit the capability section if your message should be visible for all users. For example forum post notifications are available to all users.

	<~~code~~ php>		<syntaxhighlight lang="php">
	$messageproviders = array (		$messageproviders = array (
	// Ordinary single forum posts		// Ordinary single forum posts
Line 57:		Line 57:

	When displaying your message types in a user's messaging preferences it will use a string from your component's language file called "messageprovider:messagename". For example here are the relevant strings from the quiz's language file.		When displaying your message types in a user's messaging preferences it will use a string from your component's language file called "messageprovider:messagename". For example here are the relevant strings from the quiz's language file.
	<~~code~~ php>		<syntaxhighlight lang="php">
	$string['messageprovider:confirmation'] = 'Confirmation of your own quiz submissions';		$string['messageprovider:confirmation'] = 'Confirmation of your own quiz submissions';
	$string['messageprovider:submission'] = 'Notification of quiz submissions';		$string['messageprovider:submission'] = 'Notification of quiz submissions';
Line 66:		Line 66:
	The default processor can be set using an element of the array		The default processor can be set using an element of the array
	e.g.		e.g.
	<~~code~~ php>		<syntaxhighlight lang="php">
	'mynotification' => [		'mynotification' => [
	'defaults' => [		'defaults' => [
Line 76:		Line 76:
	With that setting email will be permitted but disabled for each user by default. It can be turned on by each user through the preferences/notification preferences options (/message/notificationpreferences.php?userid=X)		With that setting email will be permitted but disabled for each user by default. It can be turned on by each user through the preferences/notification preferences options (/message/notificationpreferences.php?userid=X)
	The possible values are recorded in the lib.php file of messaging		The possible values are recorded in the lib.php file of messaging
	<~~code~~ php>		<syntaxhighlight lang="php">
	/**		/**
	* Define contants for messaging default settings population. For unambiguity of		* Define contants for messaging default settings population. For unambiguity of
Line 92:		Line 92:
	{{Moodle_2.9}}		{{Moodle_2.9}}
	Here is example code showing you how to actually send a notification message. The example shows the construction of a object with specific properties, which is then passed to the message_send() function that uses the information to send a message.		Here is example code showing you how to actually send a notification message. The example shows the construction of a object with specific properties, which is then passed to the message_send() function that uses the information to send a message.
	<~~code~~ php>		<syntaxhighlight lang="php">
	$message = new \core\message\message();		$message = new \core\message\message();
	$message->component = 'mod_yourmodule'; // Your plugin's name		$message->component = 'mod_yourmodule'; // Your plugin's name
Line 130:		Line 130:
	Before 2.9 message data used to be a stdClass object as shown below (This formation of a message will no longer work as of Moodle 3.6. Only a message object will be accepted):-		Before 2.9 message data used to be a stdClass object as shown below (This formation of a message will no longer work as of Moodle 3.6. Only a message object will be accepted):-

	<~~code~~ php>		<syntaxhighlight lang="php">
	$message = new stdClass();		$message = new stdClass();
	$message->component = 'mod_quiz'; //your component name		$message->component = 'mod_quiz'; //your component name
Line 148:		Line 148:

	Here is example code showing you how to set-up the Javascript popup link.		Here is example code showing you how to set-up the Javascript popup link.
	<~~code~~ php>		<syntaxhighlight lang="php">
	require_once('message/lib.php');		require_once('message/lib.php');
	$userid = 2;		$userid = 2;

← Older revision		Revision as of 13:02, 14 July 2021
Line 44:		Line 44:
	)		)
	);		);
	</~~code~~>		</syntaxhighlight>

	The quiz can send two kinds of messages, quiz "submission" and "confirmation" notifications. Each message type is only available to users with the appropriate capability. Please note that the capability is checked at the system level context. Users who have this capability will have this message listed in their messaging preferences. You can omit the capability section if your message should be visible for all users. For example forum post notifications are available to all users.		The quiz can send two kinds of messages, quiz "submission" and "confirmation" notifications. Each message type is only available to users with the appropriate capability. Please note that the capability is checked at the system level context. Users who have this capability will have this message listed in their messaging preferences. You can omit the capability section if your message should be visible for all users. For example forum post notifications are available to all users.
Line 54:		Line 54:
	)		)
	);		);
	</~~code~~>		</syntaxhighlight>

	When displaying your message types in a user's messaging preferences it will use a string from your component's language file called "messageprovider:messagename". For example here are the relevant strings from the quiz's language file.		When displaying your message types in a user's messaging preferences it will use a string from your component's language file called "messageprovider:messagename". For example here are the relevant strings from the quiz's language file.
Line 60:		Line 60:
	$string['messageprovider:confirmation'] = 'Confirmation of your own quiz submissions';		$string['messageprovider:confirmation'] = 'Confirmation of your own quiz submissions';
	$string['messageprovider:submission'] = 'Notification of quiz submissions';		$string['messageprovider:submission'] = 'Notification of quiz submissions';
	</~~code~~>		</syntaxhighlight>

	Once your messages.php is complete you need to increase the version number of your component in its version.php. That will cause Moodle to check messages.php looking for new or changed message definitions. Log in as an admin and go to /admin/index.php (the Notifications page) to start the upgrade process.		Once your messages.php is complete you need to increase the version number of your component in its version.php. That will cause Moodle to check messages.php looking for new or changed message definitions. Log in as an admin and go to /admin/index.php (the Notifications page) to start the upgrade process.
Line 73:		Line 73:
	],		],
	],		],
	</~~code~~>		</syntaxhighlight>
	With that setting email will be permitted but disabled for each user by default. It can be turned on by each user through the preferences/notification preferences options (/message/notificationpreferences.php?userid=X)		With that setting email will be permitted but disabled for each user by default. It can be turned on by each user through the preferences/notification preferences options (/message/notificationpreferences.php?userid=X)
	The possible values are recorded in the lib.php file of messaging		The possible values are recorded in the lib.php file of messaging
Line 86:		Line 86:
	* MESSAGE_PERMITTED_MASK contains the mask we use to distinguish permission setting		* MESSAGE_PERMITTED_MASK contains the mask we use to distinguish permission setting
	*/		*/
	</~~code~~>		</syntaxhighlight>
	Note that if you change the values in message.php and then upgrade the plugin the values will not automatically be changed in the config_plugins table where they are stored.		Note that if you change the values in message.php and then upgrade the plugin the values will not automatically be changed in the config_plugins table where they are stored.

Line 126:		Line 126:
	// Actually send the message		// Actually send the message
	$messageid = message_send($message);		$messageid = message_send($message);
	</~~code~~>		</syntaxhighlight>

	Before 2.9 message data used to be a stdClass object as shown below (This formation of a message will no longer work as of Moodle 3.6. Only a message object will be accepted):-		Before 2.9 message data used to be a stdClass object as shown below (This formation of a message will no longer work as of Moodle 3.6. Only a message object will be accepted):-
Line 143:		Line 143:
	$message->notification = 1; //this is only set to 0 for personal messages between users		$message->notification = 1; //this is only set to 0 for personal messages between users
	message_send($message);		message_send($message);
	</~~code~~>		</syntaxhighlight>

	===How to set-up the message popup===		===How to set-up the message popup===
Line 157:		Line 157:
	$attributes = message_messenger_sendmessage_link_params($userto);		$attributes = message_messenger_sendmessage_link_params($userto);
	echo html_writer::link($url, 'Send a message', $attributes);		echo html_writer::link($url, 'Send a message', $attributes);
	</~~code~~>		</syntaxhighlight>

	==Changes in Moodle 3.5==		==Changes in Moodle 3.5==
Line 181:		Line 181:

	ORDER BY m.timecreated, m.id, mem.userid, act.id		ORDER BY m.timecreated, m.id, mem.userid, act.id
	</~~code~~>		</syntaxhighlight>

	==See also==		==See also==

← Older revision		Revision as of 13:08, 26 June 2021
Line 164:		Line 164:
	In Moodle 3.5, there were some moderately big changes. The only docs I have been able to find about them are in [https://github.com/moodle/moodle/blob/33a388eff737c049786ee42d7430db549568471c/message/upgrade.txt#L56 upgrade.txt] file. However, that is the details, here is an overview:		In Moodle 3.5, there were some moderately big changes. The only docs I have been able to find about them are in [https://github.com/moodle/moodle/blob/33a388eff737c049786ee42d7430db549568471c/message/upgrade.txt#L56 upgrade.txt] file. However, that is the details, here is an overview:

	The main message_send() API to send a message has not changed, so if ~~yout~~ code is just sending messages, you don't need to do anything.		The main message_send() API to send a message has not changed, so if your code is just sending messages, you don't need to do anything.

	Similarly, message_output plugins don't need to change, so no worries there.		Similarly, message_output plugins don't need to change, so no worries there.

← Older revision		Revision as of 11:54, 26 November 2020
Line 91:		Line 91:
	===How to send a message===		===How to send a message===
	{{Moodle_2.9}}		{{Moodle_2.9}}
	Here is example code showing you how to actually send a message. The example shows the construction of a object with specific properties, which is then passed to the message_send() function that uses the information to send a message.		Here is example code showing you how to actually send a notification message. The example shows the construction of a object with specific properties, which is then passed to the message_send() function that uses the information to send a message.
	<code php>		<code php>
	$message = new \core\message\message();		$message = new \core\message\message();
	$message->component = '~~moodle~~';		$message->component = 'mod_yourmodule'; // Your plugin's name
	$message->name = '~~instantmessage~~';		$message->name = 'mynotification'; // Your notification name from message.php
	$message->userfrom = ~~$USER~~;		$message->userfrom = core_user::get_noreply_user(); // If the message is 'from' a specific user you can set them here
	$message->userto = $user;		$message->userto = $user;
	$message->subject = 'message subject 1';		$message->subject = 'message subject 1';
Line 103:		Line 103:
	$message->fullmessagehtml = '<p>message body</p>';		$message->fullmessagehtml = '<p>message body</p>';
	$message->smallmessage = 'small message';		$message->smallmessage = 'small message';
	$message->notification = ~~'0'~~;		$message->notification = 1; // Because this is a notification generated from Moodle, not a user-to-user message
	$message->contexturl = '~~http:~~//~~GalaxyFarFarAway.com~~';		$message->contexturl = (new \moodle_url('/course/'))->out(false); // A relevant URL for the notification
	$message->contexturlname = '~~Context name~~';		$message->contexturlname = 'Course list'; // Link title explaining where users get to for the contexturl
	~~$message->replyto = "random@example.com";~~
	$content = array('*' => array('header' => ' test ', 'footer' => ' test ')); // Extra content for specific processor		$content = array('*' => array('header' => ' test ', 'footer' => ' test ')); // Extra content for specific processor
	$message->set_additional_content('email', $content);		$message->set_additional_content('email', $content);
	~~$message->courseid = $course->id; // This is required in recent versions, use it from 3.2 on https://tracker.moodle.org/browse/MDL-47162~~

	// ~~Create a file instance.~~		// You probably don't need attachments but if you do, here is how to add one
	$usercontext = context_user::instance($user->id);		$usercontext = context_user::instance($user->id);
	$file = new stdClass;		$file = new stdClass;
Line 126:		Line 124:
	$message->attachment = $file;		$message->attachment = $file;

			// Actually send the message
	$messageid = message_send($message);		$messageid = message_send($message);
	</code>		</code>

← Older revision		Revision as of 02:49, 12 November 2018
Line 129:		Line 129:
	</code>		</code>

	Before 2.9 message data used to be a stdClass object as shown below:-		Before 2.9 message data used to be a stdClass object as shown below (This formation of a message will no longer work as of Moodle 3.6. Only a message object will be accepted):-

	<code php>		<code php>

← Older revision		Revision as of 12:07, 7 November 2018
Line 87:		Line 87:
	*/		*/
	</code>		</code>
	Note that if you change the values in message.php and then upgrade the plugin the values will not automatically be changed in the config_plugins table.		Note that if you change the values in message.php and then upgrade the plugin the values will not automatically be changed in the config_plugins table where they are stored.

	===How to send a message===		===How to send a message===