|
string null string | $homeserverurl = null |
| The URI of the home server.
|
|
communication_matrix local spec v1p1 null matrix_client | $matrixapi |
| The Matrix API processor.
|
|
string string | $webclienturl |
| The URI of the Matrix web client.
|
|
◆ add_members_to_room()
communication_matrix\communication_feature::add_members_to_room |
( |
array | $userids | ) |
|
◆ check_room_membership()
communication_matrix\communication_feature::check_room_membership |
( |
string | $matrixuserid | ) |
|
Check if a user is a member of a room.
Use if membership confirmation is needed before doing something else.
- Parameters
-
string | $matrixuserid | The Matrix user id to check |
- Return values
-
◆ check_user_exists()
communication_matrix\communication_feature::check_user_exists |
( |
string | $matrixuserid | ) |
|
Check if a user exists in Matrix.
Use if user existence is needed before doing something else.
- Parameters
-
string | $matrixuserid | The Matrix user id to check |
- Return values
-
◆ create_chat_room()
communication_matrix\communication_feature::create_chat_room |
( |
| ) |
|
◆ create_members()
communication_matrix\communication_feature::create_members |
( |
array | $userids | ) |
|
◆ delete_chat_room()
communication_matrix\communication_feature::delete_chat_room |
( |
| ) |
|
◆ get_body()
static communication_matrix\communication_feature::get_body |
( |
Response | $response | ) |
|
|
static |
Get the body of a response as a stdClass.
- Parameters
-
- Return values
-
◆ get_chat_room_url()
communication_matrix\communication_feature::get_chat_room_url |
( |
| ) |
|
◆ get_room_configuration()
communication_matrix\communication_feature::get_room_configuration |
( |
| ) |
|
Get the stored room configuration.
- Return values
-
◆ get_room_id()
communication_matrix\communication_feature::get_room_id |
( |
| ) |
|
Return the current room id.
- Return values
-
◆ get_user_allowed_power_level()
communication_matrix\communication_feature::get_user_allowed_power_level |
( |
int | $userid | ) |
|
Get the allowed power level for the user id according to perms/site admin or default.
- Parameters
-
- Return values
-
◆ is_configured()
static communication_matrix\communication_feature::is_configured |
( |
| ) |
|
|
static |
Check if the provider is configured or not.
This method is intended to check if the plugin have got any settings and if all the settings are set properly. This checking helps to reduce errors in future when a communication instance is added for the provider and not configured.
Implements core_communication\communication_provider.
◆ load_for_instance()
static communication_matrix\communication_feature::load_for_instance |
( |
processor | $communication | ) |
|
|
static |
Load the communication provider for the communication api.
- Parameters
-
processor | $communication | The communication processor object |
- Return values
-
communication_feature | The communication provider object |
Implements core_communication\communication_provider.
◆ reload()
communication_matrix\communication_feature::reload |
( |
| ) |
|
Reload the room information.
This may be necessary after a room has been created or updated via the adhoc task. This is primarily intended for use in unit testing, but may have real world cases too.
◆ remote_room_exists()
communication_matrix\communication_feature::remote_room_exists |
( |
| ) |
|
|
protected |
Whether the room exists on the remote server.
This does not involve a remote call, but checks whether Moodle is aware of the room id.
- Return values
-
◆ remove_members_from_room()
communication_matrix\communication_feature::remove_members_from_room |
( |
array | $userids | ) |
|
◆ room_exists()
communication_matrix\communication_feature::room_exists |
( |
| ) |
|
|
protected |
Check whether the room configuration has been created yet.
- Return values
-
◆ save_form_data()
communication_matrix\communication_feature::save_form_data |
( |
\stdClass | $instance | ) |
|
Set the form data to the instance if any data is available.
- Parameters
-
stdClass | $instance | The actual instance to set the data |
Implements core_communication\form_provider.
◆ set_form_data()
communication_matrix\communication_feature::set_form_data |
( |
\stdClass | $instance | ) |
|
Set the form data to the instance if any data is available.
- Parameters
-
stdClass | $instance | The actual instance to set the data |
Implements core_communication\form_provider.
◆ set_form_definition()
static communication_matrix\communication_feature::set_form_definition |
( |
\MoodleQuickForm | $mform | ) |
|
|
static |
◆ synchronise_room_members()
communication_matrix\communication_feature::synchronise_room_members |
( |
| ) |
|
◆ update_chat_room()
communication_matrix\communication_feature::update_chat_room |
( |
| ) |
|
◆ update_room_membership()
communication_matrix\communication_feature::update_room_membership |
( |
array | $userids | ) |
|
The documentation for this class was generated from the following file:
- communication/provider/matrix/classes/communication_feature.php