|
| | can_send_to_any_users () |
| | Returns true if message can be sent to fake/internal user as well.
|
| |
| | cleanup_all_notifications (int $notificationdeletetime) |
| | Allow processors to perform cleanup tasks for all notifications by overriding this method.
|
| |
| | cleanup_read_notifications (int $notificationdeletetime) |
| | Allow processors to perform cleanup tasks for read notifications by overriding this method.
|
| |
| | config_form ($preferences) |
| | Create necessary fields in the config form on the messaging preferences page.
|
| |
| | force_process_messages () |
| | Determines if this processor should process a message regardless of user preferences or site settings.
|
| |
| | get_default_messaging_settings () |
| | Returns the message processors default settings Should the processor be enabled in users by default?
|
| |
| | has_message_preferences () |
| | Returns true if this processor has configurable message preferences.
|
| |
| | is_system_configured () |
| | Are the message processor's system settings configured?
|
| |
| | is_user_configured ($user=null) |
| | Are the message processor's user specific settings configured?
|
| |
| | load_data (&$preferences, $userid) |
| | Load the config data from database to put on the config form on the messaging preferences page.
|
| |
| | process_form ($form, &$preferences) |
| | Parse the submitted form and save data into an array of user preferences.
|
| |
| | send_message ($message) |
| | Process a message received by a user.
|
| |
| | should_send_sms (stdclass $messagedata) |
| | Check whether the SMS message data fulfills the requirements.
|
| |
◆ can_send_to_any_users()
| message_output_sms::can_send_to_any_users |
( |
| ) |
|
Returns true if message can be sent to fake/internal user as well.
If message_output support message to be sent to fake user, then it should return true, like email.
- Return values
-
Reimplemented from message_output.
◆ cleanup_all_notifications()
| message_output::cleanup_all_notifications |
( |
int | $notificationdeletetime | ) |
|
|
inherited |
Allow processors to perform cleanup tasks for all notifications by overriding this method.
- Since
- Moodle 3.9
- Parameters
-
| int | $notificationdeletetime | |
- Return values
-
◆ cleanup_read_notifications()
| message_output::cleanup_read_notifications |
( |
int | $notificationdeletetime | ) |
|
|
inherited |
Allow processors to perform cleanup tasks for read notifications by overriding this method.
- Since
- Moodle 3.9
- Parameters
-
| int | $notificationdeletetime | |
- Return values
-
◆ config_form()
| message_output_sms::config_form |
( |
| $preferences | ) |
|
Create necessary fields in the config form on the messaging preferences page.
- Parameters
-
| array | $preferences | An array of user preferences |
Reimplemented from message_output.
◆ force_process_messages()
| message_output::force_process_messages |
( |
| ) |
|
|
inherited |
Determines if this processor should process a message regardless of user preferences or site settings.
- Return values
-
◆ get_default_messaging_settings()
| message_output_sms::get_default_messaging_settings |
( |
| ) |
|
Returns the message processors default settings Should the processor be enabled in users by default?
Is enabling it disallowed, permitted or forced?
- Return values
-
| int | The Default message output settings expressed as a bit mask MESSAGE_DEFAULT_ENABLED + MESSAGE_PERMITTED |
Reimplemented from message_output.
◆ has_message_preferences()
| message_output::has_message_preferences |
( |
| ) |
|
|
inherited |
Returns true if this processor has configurable message preferences.
This is distinct from notification preferences.
- Return values
-
◆ is_system_configured()
| message_output::is_system_configured |
( |
| ) |
|
|
inherited |
Are the message processor's system settings configured?
- Return values
-
| bool | True if all necessary config settings been entered |
Reimplemented in message_output_airnotifier.
◆ is_user_configured()
| message_output_sms::is_user_configured |
( |
| $user = null | ) |
|
Are the message processor's user specific settings configured?
- Parameters
-
| stdClass | $user | the user object, defaults to $USER. |
- Return values
-
| bool | True if the user has all necessary settings in their messaging preferences |
Reimplemented from message_output.
◆ load_data()
| message_output_sms::load_data |
( |
& | $preferences, |
|
|
| $userid ) |
Load the config data from database to put on the config form on the messaging preferences page.
- Parameters
-
| array | $preferences | Array of user preferences |
| int | $userid | The user ID |
Reimplemented from message_output.
◆ process_form()
| message_output_sms::process_form |
( |
| $form, |
|
|
& | $preferences ) |
Parse the submitted form and save data into an array of user preferences.
- Parameters
-
| stdClass | $form | preferences form class |
| array | $preferences | preferences array |
Reimplemented from message_output.
◆ send_message()
| message_output_sms::send_message |
( |
| $message | ) |
|
Process a message received by a user.
- See also
- message_send()
- Parameters
-
| stdClass | $message | The event data submitted by the message provider to message_send() plus $eventdata->savedmessageid |
Reimplemented from message_output.
◆ should_send_sms()
| message_output_sms::should_send_sms |
( |
stdclass | $messagedata | ) |
|
Check whether the SMS message data fulfills the requirements.
- Parameters
-
| stdclass | $messagedata | The message data |
- Return values
-
The documentation for this class was generated from the following file:
- message/output/sms/message_output_sms.php
1.13.2