Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
communication_matrix Namespace Reference

  More...

Namespaces

namespace  local
  
 
namespace  privacy
  
 

Classes

class  communication_feature
 class communication_feature to handle matrix specific actions. More...
 
class  matrix_client
 The abstract class for a versioned API client for Matrix. More...
 
class  matrix_constants
 class matrix_constants to have one location to store all constants related to matrix. More...
 
class  matrix_room
 Class to manage the updates to the room information in db. More...
 
class  matrix_user_manager
 class matrix_user_manager to handle specific actions. More...
 

Functions

 backoffice_create_users_and_rooms (array $users=[], array $rooms=[],)
 A backoffice method to create users and rooms on our mock server.
 
 backoffice_get_all_rooms ()
 Fetch all rooms from the back office.
 
 backoffice_get_all_users ()
 A backoffice call to get all registered users from our mock server.
 
 backoffice_get_room ()
 Return the first room from the server.
 
 create_matrix_room (?string $component='core_course', ?string $itemtype='example', ?int $itemid=1, ?string $roomname=null, ?string $roomtopic=null, ?\stored_file $roomavatar=null, array $members=[], ?context $context=null,)
 Helper to create a room.
 
 get_backoffice_uri (string $endpoint)
 Get the URI of a backoffice endpoint on the mock server.
 
 get_matrix_access_token ()
 Get the matrix access token.
 
 get_matrix_room_data (string $roomid)
 Get matrix room data from matrix server.
 
 get_matrix_server_url ()
 Get the mock server url.
 
 get_matrix_user_data (string $roomid, string $matrixuserid)
 Get matrix user data from matrix server.
 
 initialise_mock_configs ()
 Initialize the mock configs in settings.
 
 initialise_mock_server ()
 This test requires mock server to be present.
 
 request (array $jsonarray=[], array $headers=[])
 The http request for the api call.
 
 reset_mock ()
 Reset the mock server.
 

Variables

string string $matrixhomeserverurl
 $matrixhomeserverurl The server url of matrix synapse server
 
trait matrix_test_helper_trait
 Trait matrix_helper_trait to generate initial setup for matrix mock and associated helpers.
 

Detailed Description