Chat external functions. More...

Inheritance diagram for mod_chat_external:

Static Public Member Functions
static	get_chat_latest_messages ($chatsid, $chatlasttime=0)
	Get the latest messages from the given chat session.

static	get_chat_latest_messages_parameters ()
	Returns description of method parameters.

static	get_chat_latest_messages_returns ()
	Returns description of method result value.

static	get_chat_users ($chatsid)
	Get the list of users in the given chat session.

static	get_chat_users_parameters ()
	Returns description of method parameters.

static	get_chat_users_returns ()
	Returns description of method result value.

static	get_chats_by_courses ($courseids=array())
	Returns a list of chats in a provided list of courses, if no list is provided all chats that the user can view will be returned.

static	get_chats_by_courses_parameters ()
	Describes the parameters for get_chats_by_courses.

static	get_chats_by_courses_returns ()
	Describes the get_chats_by_courses return value.

static	get_session_messages ($chatid, $sessionstart, $sessionend, $groupid=0)
	Retrieves messages of the given chat session.

static	get_session_messages_parameters ()
	Returns description of method parameters.

static	get_session_messages_returns ()
	Returns description of method result value.

static	get_sessions ($chatid, $groupid=0, $showall=false)
	Retrieves chat sessions for a given chat.

static	get_sessions_parameters ()
	Returns description of method parameters.

static	get_sessions_returns ()
	Returns description of method result value.

static	login_user ($chatid, $groupid=0)
	Log the current user into a chat room in the given chat.

static	login_user_parameters ()
	Returns description of method parameters.

static	login_user_returns ()
	Returns description of method result value.

static	send_chat_message ($chatsid, $messagetext, $beepid='')
	Send a message on the given chat session.

static	send_chat_message_parameters ()
	Returns description of method parameters.

static	send_chat_message_returns ()
	Returns description of method result value.

static	view_chat ($chatid)
	Trigger the course module viewed event and update the module completion status.

static	view_chat_parameters ()
	Returns description of method parameters.

static	view_chat_returns ()
	Returns description of method result value.

Detailed Description

Chat external functions.

Copyright: 2015 Juan Leyva juan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

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

Since: Moodle 3.0

Member Function Documentation

◆ get_chat_latest_messages()

static mod_chat_external::get_chat_latest_messages	(		$chatsid,
			$chatlasttime = 0 )

static

Get the latest messages from the given chat session.

Parameters

int	$chatsid	the chat session id
int	$chatlasttime	last time messages were retrieved (epoch time)

Return values

array of warnings and the new message id (0 if the message was empty)

Since: Moodle 3.0

Exceptions

moodle_exception

◆ get_chat_latest_messages_parameters()

static mod_chat_external::get_chat_latest_messages_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 3.0

◆ get_chat_latest_messages_returns()

static mod_chat_external::get_chat_latest_messages_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since: Moodle 3.0

◆ get_chat_users()

static mod_chat_external::get_chat_users ( $chatsid )

static

Get the list of users in the given chat session.

Parameters

int $chatsid the chat session id

Return values

array of warnings and the user lists

Since: Moodle 3.0

Exceptions

moodle_exception

◆ get_chat_users_parameters()

static mod_chat_external::get_chat_users_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 3.0

◆ get_chat_users_returns()

static mod_chat_external::get_chat_users_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since: Moodle 3.0

◆ get_chats_by_courses()

static mod_chat_external::get_chats_by_courses ( $courseids = array() )

static

Returns a list of chats in a provided list of courses, if no list is provided all chats that the user can view will be returned.

Parameters

array $courseids the course ids

Return values

array of chats details

Since: Moodle 3.0

◆ get_chats_by_courses_parameters()

static mod_chat_external::get_chats_by_courses_parameters ( )

static

Describes the parameters for get_chats_by_courses.

Return values

external_function_parameters

Since: Moodle 3.0

◆ get_chats_by_courses_returns()

static mod_chat_external::get_chats_by_courses_returns ( )

static

Describes the get_chats_by_courses return value.

Return values

external_single_structure

Since: Moodle 3.0

◆ get_session_messages()

static mod_chat_external::get_session_messages	(	$chatid,
		$sessionstart,
		$sessionend,
		$groupid = 0 )

static

Retrieves messages of the given chat session.

Parameters

int	$chatid	the chat instance id
int	$sessionstart	the session start time (timestamp)
int	$sessionend	the session end time (timestamp)
int	$groupid	filter messages by this group. 0 to determine the group.

Return values

array of warnings and the messages

Since: Moodle 3.4

Exceptions

moodle_exception

◆ get_session_messages_parameters()

static mod_chat_external::get_session_messages_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 3.4

◆ get_session_messages_returns()

static mod_chat_external::get_session_messages_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since: Moodle 3.4

◆ get_sessions()

static mod_chat_external::get_sessions	(	$chatid,
		$groupid = 0,
		$showall = false )

static

Retrieves chat sessions for a given chat.

Parameters

int	$chatid	the chat instance id
int	$groupid	filter messages by this group. 0 to determine the group.
bool	$showall	whether to include incomplete sessions or not

Return values

array of warnings and the sessions

Since: Moodle 3.4

Exceptions

moodle_exception

◆ get_sessions_parameters()

static mod_chat_external::get_sessions_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 3.4

◆ get_sessions_returns()

static mod_chat_external::get_sessions_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since: Moodle 3.4

◆ login_user()

static mod_chat_external::login_user	(		$chatid,
			$groupid = 0 )

static

Log the current user into a chat room in the given chat.

Parameters

int	$chatid	the chat instance id
int	$groupid	the user group id

Return values

array of warnings and the chat unique session id

Since: Moodle 3.0

Exceptions

moodle_exception

◆ login_user_parameters()

static mod_chat_external::login_user_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 3.0

◆ login_user_returns()

static mod_chat_external::login_user_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since: Moodle 3.0

◆ send_chat_message()

static mod_chat_external::send_chat_message	(	$chatsid,
		$messagetext,
		$beepid = '' )

static

Send a message on the given chat session.

Parameters

int	$chatsid	the chat session id
string	$messagetext	the message text
string	$beepid	the beep message id

Return values

array of warnings and the new message id (0 if the message was empty)

Since: Moodle 3.0

Exceptions

moodle_exception

◆ send_chat_message_parameters()

static mod_chat_external::send_chat_message_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 3.0

◆ send_chat_message_returns()

static mod_chat_external::send_chat_message_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since: Moodle 3.0

◆ view_chat()

static mod_chat_external::view_chat ( $chatid )

static

Trigger the course module viewed event and update the module completion status.

Parameters

int $chatid the chat instance id

Return values

array of warnings and status result

Since: Moodle 3.0

Exceptions

moodle_exception

◆ view_chat_parameters()

static mod_chat_external::view_chat_parameters ( )

static

Returns description of method parameters.

Return values

external_function_parameters

Since: Moodle 3.0

◆ view_chat_returns()

static mod_chat_external::view_chat_returns ( )

static

Returns description of method result value.

Return values

core_external\external_description

Since: Moodle 3.0

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

mod/chat/classes/external.php

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ get_chat_latest_messages()

◆ get_chat_latest_messages_parameters()

◆ get_chat_latest_messages_returns()

◆ get_chat_users()

◆ get_chat_users_parameters()

◆ get_chat_users_returns()

◆ get_chats_by_courses()

◆ get_chats_by_courses_parameters()

◆ get_chats_by_courses_returns()

◆ get_session_messages()

◆ get_session_messages_parameters()

◆ get_session_messages_returns()

◆ get_sessions()

◆ get_sessions_parameters()

◆ get_sessions_returns()

◆ login_user()

◆ login_user_parameters()

◆ login_user_returns()

◆ send_chat_message()

◆ send_chat_message_parameters()

◆ send_chat_message_returns()

◆ view_chat()

◆ view_chat_parameters()

◆ view_chat_returns()