mod_chat_external Class Reference

Chat external functions. More...

Inheritance diagram for mod_chat_external:

Static Public Member Functions
static	call_external_function ($function, $args, $ajaxonly=false)
	Call an external function validating all params/returns correctly.
static	clean_returnvalue (external_description $description, $response)
	Clean response If a response attribute is unknown from the description, we just ignore the attribute.
static	external_function_info ($function, $strictness=MUST_EXIST)
	Returns detailed function information.
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	set_context_restriction ($context)
	Set context restriction for all following subsequent function calls.
static	set_timeout ($seconds=360)
	This method has to be called before every operation that takes a longer time to finish!
static	validate_context ($context)
	Makes sure user may execute functions in this context.
static	validate_parameters (external_description $description, $params)
	Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.
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.

Static Protected Member Functions
static	get_context_from_params ($param)
	Get context from passed parameters.
static	get_context_parameters ()
	Returns a prepared structure to use a context parameters.

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

call_external_function()

static external_api::call_external_function ( $function, $args, $ajaxonly = false )

staticinherited

Call an external function validating all params/returns correctly.

Note that an external function may modify the state of the current page, so this wrapper saves and restores tha PAGE and COURSE global variables before/after calling the external function.

Parameters

string	$function	A webservice function name.
array	$args	Params array (named params)
boolean	$ajaxonly	If true, an extra check will be peformed to see if ajax is required.

Return values

array

containing keys for error (bool), exception and data.

clean_returnvalue()

static external_api::clean_returnvalue ( external_description $description, $response )

staticinherited

Clean response If a response attribute is unknown from the description, we just ignore the attribute.

If a response attribute is incorrect, invalid_response_exception is thrown. Note: this function is similar to validate parameters, however it is distinct because parameters validation must be distinct from cleaning return values.

Parameters

external_description	$description	description of the return values
mixed	$response	the actual response

Return values

mixed

response with added defaults for optional items, invalid_response_exception thrown if any problem found

Author

2010 Jerome Mouneyrac

Since

Moodle 2.0

external_function_info()

static external_api::external_function_info ( $function, $strictness = MUST_EXIST )

staticinherited

Returns detailed function information.

Parameters

string | object	$function	name of external function or record from external_function
int	$strictness	IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found; MUST_EXIST means throw exception if no record or multiple records found

Return values

stdClass

description or false if not found or exception thrown

Exceptions

coding_exception

for any property and/or method that is missing or invalid

Since

Moodle 2.0

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

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

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_context_from_params()

static external_api::get_context_from_params ( $param )

staticprotectedinherited

Get context from passed parameters.

The passed array must either contain a contextid or a combination of context level and instance id to fetch the context. For example, the context level can be "course" and instanceid can be courseid.

See context_helper\get_all_levels() for a list of valid context levels.

Parameters

array

$param

Since

Moodle 2.6

Exceptions

invalid_parameter_exception

Return values

context

get_context_parameters()

static external_api::get_context_parameters ( )

staticprotectedinherited

Returns a prepared structure to use a context parameters.

Return values

external_single_structure

Reimplemented in core_competency\external, and tool_lp\external.

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

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

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

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

external_description

Since

Moodle 3.0

set_context_restriction()

static external_api::set_context_restriction ( $context )

staticinherited

Set context restriction for all following subsequent function calls.

Parameters

stdClass

$context

the context restriction

Since

Moodle 2.0

set_timeout()

static external_api::set_timeout ( $seconds = 360 )

staticinherited

This method has to be called before every operation that takes a longer time to finish!

Parameters

int

$seconds

max expected time the next operation needs

Since

Moodle 2.0

validate_context()

static external_api::validate_context ( $context )

staticinherited

Makes sure user may execute functions in this context.

Parameters

stdClass

$context

Since

Moodle 2.0

validate_parameters()

static external_api::validate_parameters ( external_description $description, $params )

staticinherited

Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown.

This is a simple recursive method which is intended to be called from each implementation method of external API.

Parameters

external_description	$description	description of parameters
mixed	$params	the actual parameters

Return values

mixed

params with added defaults for optional items, invalid_parameters_exception thrown if any problem found

Since

Moodle 2.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

external_description

Since

Moodle 3.0

---

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

• mod/chat/classes/external.php