core_communication\room_chat_provider Interface Reference

Class communication_room_base to manage the room operations of communication providers. More...

Inheritance diagram for core_communication\room_chat_provider:

Public Member Functions
	create_chat_room ()
	Create a provider room when a instance is created.
	delete_chat_room ()
	Delete a provider room when a instance is deleted.
	get_chat_room_url ()
	Generate a room url if there is a room.
	update_chat_room ()
	Update a provider room when a instance is updated.

Detailed Description

Class communication_room_base to manage the room operations of communication providers.

Every plugin that supports room operation must implement/extend this class in the plugin.

Copyright

2023 Safat Shahin safat.nosp@m..sha.nosp@m.hin@m.nosp@m.oodl.nosp@m.e.com

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

create_chat_room()

core_communication\room_chat_provider::create_chat_room

(

)

Create a provider room when a instance is created.

Implemented in communication_customlink\communication_feature, and communication_matrix\communication_feature.

delete_chat_room()

core_communication\room_chat_provider::delete_chat_room

(

)

Delete a provider room when a instance is deleted.

Implemented in communication_customlink\communication_feature, and communication_matrix\communication_feature.

get_chat_room_url()

core_communication\room_chat_provider::get_chat_room_url

(

)

Generate a room url if there is a room.

Return values

string|null

Implemented in communication_customlink\communication_feature, and communication_matrix\communication_feature.

update_chat_room()

core_communication\room_chat_provider::update_chat_room

(

)

Update a provider room when a instance is updated.

Implemented in communication_customlink\communication_feature, and communication_matrix\communication_feature.

---

The documentation for this interface was generated from the following file:

• communication/classes/room_chat_provider.php