Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Static Public Member Functions | Static Protected Member Functions | List of all members
mod_forum_external Class Reference
Inheritance diagram for mod_forum_external:
external_api

Static Public Member Functions

static add_discussion ($forumid, $subject, $message, $groupid=0, $options=array())
 Add a new discussion into an existing forum. More...
 
static add_discussion_parameters ()
 Returns description of method parameters. More...
 
static add_discussion_post ($postid, $subject, $message, $options=array(), $messageformat=FORMAT_HTML)
 Create new posts into an existing discussion. More...
 
static add_discussion_post_parameters ()
 Returns description of method parameters. More...
 
static add_discussion_post_returns ()
 Returns description of method result value. More...
 
static add_discussion_returns ()
 Returns description of method result value. More...
 
static call_external_function ($function, $args, $ajaxonly=false)
 Call an external function validating all params/returns correctly. More...
 
static can_add_discussion ($forumid, $groupid=null)
 Check if the current user can add discussions in the given forum (and optionally for the given group). More...
 
static can_add_discussion_parameters ()
 Returns description of method parameters. More...
 
static can_add_discussion_returns ()
 Returns description of method result value. More...
 
static clean_returnvalue (external_description $description, $response)
 Clean response If a response attribute is unknown from the description, we just ignore the attribute. More...
 
static delete_post ($postid)
 Deletes a post or a discussion completely when the post is the discussion topic. More...
 
static delete_post_parameters ()
 Returns description of method parameters. More...
 
static delete_post_returns ()
 Returns description of method result value. More...
 
static external_function_info ($function, $strictness=MUST_EXIST)
 Returns detailed function information. More...
 
static get_discussion_post ($postid)
 Get a particular discussion post. More...
 
static get_discussion_post_parameters ()
 Returns description of method parameters. More...
 
static get_discussion_post_returns ()
 Returns description of method result value. More...
 
static get_discussion_posts (int $discussionid, ?string $sortby, ?string $sortdirection)
 Get the forum posts in the specified discussion. More...
 
static get_discussion_posts_by_userid (int $userid=0, int $cmid, ?string $sortby, ?string $sortdirection)
 Get the forum posts in the specified forum instance. More...
 
static get_discussion_posts_by_userid_parameters ()
 Describe the post parameters. More...
 
static get_discussion_posts_by_userid_returns ()
 Describe the post return format. More...
 
static get_discussion_posts_parameters ()
 Describe the post parameters. More...
 
static get_discussion_posts_returns ()
 Describe the post return format. More...
 
static get_forum_access_information ($forumid)
 Return access information for a given forum. More...
 
static get_forum_access_information_parameters ()
 Describes the parameters for get_forum_access_information. More...
 
static get_forum_access_information_returns ()
 Describes the get_forum_access_information return value. More...
 
static get_forum_discussion_posts ($discussionid, $sortby="created", $sortdirection="DESC")
 Returns a list of forum posts for a discussion. More...
 
static get_forum_discussion_posts_is_deprecated ()
 Mark the get_forum_discussion_posts web service as deprecated. More...
 
static get_forum_discussion_posts_parameters ()
 Describes the parameters for get_forum_discussion_posts. More...
 
static get_forum_discussion_posts_returns ()
 Describes the get_forum_discussion_posts return value. More...
 
static get_forum_discussions (int $forumid, ?int $sortorder=-1, ?int $page=-1, ?int $perpage=0, ?int $groupid=0)
 Returns a list of forum discussions optionally sorted and paginated. More...
 
static get_forum_discussions_paginated ($forumid, $sortby='timemodified', $sortdirection='DESC', $page=-1, $perpage=0)
 Returns a list of forum discussions optionally sorted and paginated. More...
 
static get_forum_discussions_paginated_parameters ()
 Describes the parameters for get_forum_discussions_paginated. More...
 
static get_forum_discussions_paginated_returns ()
 Describes the get_forum_discussions_paginated return value. More...
 
static get_forum_discussions_parameters ()
 Describes the parameters for get_forum_discussions. More...
 
static get_forum_discussions_returns ()
 Describes the get_forum_discussions return value. More...
 
static get_forums_by_courses ($courseids=array())
 Returns a list of forums in a provided list of courses, if no list is provided all forums that the user can view will be returned. More...
 
static get_forums_by_courses_parameters ()
 Describes the parameters for get_forum. More...
 
static get_forums_by_courses_returns ()
 Describes the get_forum return value. More...
 
static prepare_draft_area_for_post ($postid, $area, $draftitemid=0, $filestokeep=[])
 Prepares a draft area for editing a post. More...
 
static prepare_draft_area_for_post_parameters ()
 Returns description of method parameters. More...
 
static prepare_draft_area_for_post_returns ()
 Returns description of method result value. More...
 
static set_context_restriction ($context)
 Set context restriction for all following subsequent function calls. More...
 
static set_lock_state ($forumid, $discussionid, $targetstate)
 Set the lock state. More...
 
static set_lock_state_parameters ()
 Returns description of method parameters. More...
 
static set_lock_state_returns ()
 Returns description of method result value. More...
 
static set_pin_state ($discussionid, $targetstate)
 Set the pin state. More...
 
static set_pin_state_parameters ()
 Returns description of method parameters. More...
 
static set_pin_state_returns ()
 Returns description of method result value. More...
 
static set_subscription_state ($forumid, $discussionid, $targetstate)
 Set the subscription state. More...
 
static set_subscription_state_parameters ()
 Returns description of method parameters. More...
 
static set_subscription_state_returns ()
 Returns description of method result value. More...
 
static set_timeout ($seconds=360)
 This method has to be called before every operation that takes a longer time to finish! More...
 
static toggle_favourite_state ($discussionid, $targetstate)
 Toggle the favouriting value for the discussion provided. More...
 
static toggle_favourite_state_parameters ()
 Defines the parameters for the toggle_favourite_state method. More...
 
static toggle_favourite_state_returns ()
 Returns description of method result value. More...
 
static update_discussion_post ($postid, $subject='', $message='', $messageformat=FORMAT_HTML, $options=[])
 Updates a post or a discussion post topic. More...
 
static update_discussion_post_parameters ()
 Returns description of method parameters. More...
 
static update_discussion_post_returns ()
 Returns description of method result value. More...
 
static validate_context ($context)
 Makes sure user may execute functions in this context. More...
 
static validate_parameters (external_description $description, $params)
 Validates submitted function parameters, if anything is incorrect invalid_parameter_exception is thrown. More...
 
static view_forum ($forumid)
 Trigger the course module viewed event and update the module completion status. More...
 
static view_forum_discussion ($discussionid)
 Trigger the discussion viewed event. More...
 
static view_forum_discussion_parameters ()
 Returns description of method parameters. More...
 
static view_forum_discussion_returns ()
 Returns description of method result value. More...
 
static view_forum_parameters ()
 Returns description of method parameters. More...
 
static view_forum_returns ()
 Returns description of method result value. More...
 

Static Protected Member Functions

static get_context_from_params ($param)
 Get context from passed parameters. More...
 
static get_context_parameters ()
 Returns a prepared structure to use a context parameters. More...
 

Member Function Documentation

◆ add_discussion()

static mod_forum_external::add_discussion (   $forumid,
  $subject,
  $message,
  $groupid = 0,
  $options = array() 
)
static

Add a new discussion into an existing forum.

Parameters
int$forumidthe forum instance id
string$subjectnew discussion subject
string$messagenew discussion message (only html format allowed)
int$groupidthe user course group
array$optionsoptional settings
Return values
arrayof warnings and the new discussion id
Since
Moodle 3.0
Exceptions
moodle_exception

◆ add_discussion_parameters()

static mod_forum_external::add_discussion_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.0

◆ add_discussion_post()

static mod_forum_external::add_discussion_post (   $postid,
  $subject,
  $message,
  $options = array(),
  $messageformat = FORMAT_HTML 
)
static

Create new posts into an existing discussion.

Parameters
int$postidthe post id we are going to reply to
string$subjectnew post subject
string$messagenew post message (html assumed if messageformat is not provided)
array$optionsoptional settings
string$messageformatThe format of the message, defaults to FORMAT_HTML for BC
Return values
arrayof warnings and the new post id
Since
Moodle 3.0
Exceptions
moodle_exception

◆ add_discussion_post_parameters()

static mod_forum_external::add_discussion_post_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.0

◆ add_discussion_post_returns()

static mod_forum_external::add_discussion_post_returns ( )
static

Returns description of method result value.

Return values
external_description
Since
Moodle 3.0

◆ add_discussion_returns()

static mod_forum_external::add_discussion_returns ( )
static

Returns description of method result value.

Return values
external_description
Since
Moodle 3.0

◆ 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$functionA webservice function name.
array$argsParams array (named params)
boolean$ajaxonlyIf true, an extra check will be peformed to see if ajax is required.
Return values
arraycontaining keys for error (bool), exception and data.

◆ can_add_discussion()

static mod_forum_external::can_add_discussion (   $forumid,
  $groupid = null 
)
static

Check if the current user can add discussions in the given forum (and optionally for the given group).

Parameters
int$forumidthe forum instance id
int$groupidthe group to check, default to active group. Use -1 to check if the user can post in all the groups.
Return values
arrayof warnings and the status (true if the user can add discussions)
Since
Moodle 3.1
Exceptions
moodle_exception

◆ can_add_discussion_parameters()

static mod_forum_external::can_add_discussion_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.1

◆ can_add_discussion_returns()

static mod_forum_external::can_add_discussion_returns ( )
static

Returns description of method result value.

Return values
external_description
Since
Moodle 3.1

◆ 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$descriptiondescription of the return values
mixed$responsethe actual response
Return values
mixedresponse with added defaults for optional items, invalid_response_exception thrown if any problem found
Author
2010 Jerome Mouneyrac
Since
Moodle 2.0

◆ delete_post()

static mod_forum_external::delete_post (   $postid)
static

Deletes a post or a discussion completely when the post is the discussion topic.

Parameters
int$postidpost to be deleted, it can be a discussion topic post.
Return values
arrayof warnings and the status (true if the post/discussion was deleted)
Since
Moodle 3.8
Exceptions
moodle_exception

◆ delete_post_parameters()

static mod_forum_external::delete_post_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.8

◆ delete_post_returns()

static mod_forum_external::delete_post_returns ( )
static

Returns description of method result value.

Return values
external_description
Since
Moodle 3.8

◆ external_function_info()

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

Returns detailed function information.

Parameters
string | object$functionname of external function or record from external_function
int$strictnessIGNORE_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
stdClassdescription or false if not found or exception thrown
Since
Moodle 2.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 tool_lp\external, and core_competency\external.

◆ get_discussion_post()

static mod_forum_external::get_discussion_post (   $postid)
static

Get a particular discussion post.

Parameters
int$postidpost to fetch
Return values
arrayof post and warnings (if any)
Since
Moodle 3.8
Exceptions
moodle_exception

◆ get_discussion_post_parameters()

static mod_forum_external::get_discussion_post_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.8

◆ get_discussion_post_returns()

static mod_forum_external::get_discussion_post_returns ( )
static

Returns description of method result value.

Return values
external_description
Since
Moodle 3.8

◆ get_discussion_posts()

static mod_forum_external::get_discussion_posts ( int  $discussionid,
?string  $sortby,
?string  $sortdirection 
)
static

Get the forum posts in the specified discussion.

Parameters
int$discussionid
string$sortby
string$sortdirection
Return values
array

◆ get_discussion_posts_by_userid()

static mod_forum_external::get_discussion_posts_by_userid ( int  $userid = 0,
int  $cmid,
?string  $sortby,
?string  $sortdirection 
)
static

Get the forum posts in the specified forum instance.

Parameters
int$userid
int$cmid
string$sortby
string$sortdirection
Return values
array

◆ get_discussion_posts_by_userid_parameters()

static mod_forum_external::get_discussion_posts_by_userid_parameters ( )
static

Describe the post parameters.

Return values
external_function_parameters

◆ get_discussion_posts_by_userid_returns()

static mod_forum_external::get_discussion_posts_by_userid_returns ( )
static

Describe the post return format.

Return values
external_single_structure

◆ get_discussion_posts_parameters()

static mod_forum_external::get_discussion_posts_parameters ( )
static

Describe the post parameters.

Return values
external_function_parameters

◆ get_discussion_posts_returns()

static mod_forum_external::get_discussion_posts_returns ( )
static

Describe the post return format.

Return values
external_single_structure

◆ get_forum_access_information()

static mod_forum_external::get_forum_access_information (   $forumid)
static

Return access information for a given forum.

Parameters
int$forumidforum instance id
Return values
arrayof warnings and the access information
Since
Moodle 3.7
Exceptions
moodle_exception

◆ get_forum_access_information_parameters()

static mod_forum_external::get_forum_access_information_parameters ( )
static

Describes the parameters for get_forum_access_information.

Return values
external_external_function_parameters
Since
Moodle 3.7

◆ get_forum_access_information_returns()

static mod_forum_external::get_forum_access_information_returns ( )
static

Describes the get_forum_access_information return value.

Return values
external_single_structure
Since
Moodle 3.7

◆ get_forum_discussion_posts()

static mod_forum_external::get_forum_discussion_posts (   $discussionid,
  $sortby = "created",
  $sortdirection = "DESC" 
)
static

Returns a list of forum posts for a discussion.

Parameters
int$discussionidthe post ids
string$sortbysort by this element (id, created or modified)
string$sortdirectionsort direction: ASC or DESC
Return values
arraythe forum post details
Since
Moodle 2.7
Todo:
MDL-65252 This will be removed in Moodle 4.1

◆ get_forum_discussion_posts_is_deprecated()

static mod_forum_external::get_forum_discussion_posts_is_deprecated ( )
static

Mark the get_forum_discussion_posts web service as deprecated.

Return values
bool

◆ get_forum_discussion_posts_parameters()

static mod_forum_external::get_forum_discussion_posts_parameters ( )
static

Describes the parameters for get_forum_discussion_posts.

Return values
external_function_parameters
Since
Moodle 2.7

◆ get_forum_discussion_posts_returns()

static mod_forum_external::get_forum_discussion_posts_returns ( )
static

Describes the get_forum_discussion_posts return value.

Return values
external_single_structure
Since
Moodle 2.7

◆ get_forum_discussions()

static mod_forum_external::get_forum_discussions ( int  $forumid,
?int  $sortorder = -1,
?int  $page = -1,
?int  $perpage = 0,
?int  $groupid = 0 
)
static

Returns a list of forum discussions optionally sorted and paginated.

Parameters
int$forumidthe forum instance id
int$sortorderThe sort order
int$pagepage number
int$perpageitems per page
int$groupidthe user course group
Return values
arraythe forum discussion details including warnings
Since
Moodle 3.7

◆ get_forum_discussions_paginated()

static mod_forum_external::get_forum_discussions_paginated (   $forumid,
  $sortby = 'timemodified',
  $sortdirection = 'DESC',
  $page = -1,
  $perpage = 0 
)
static

Returns a list of forum discussions optionally sorted and paginated.

Deprecated:
since 3.7
Parameters
int$forumidthe forum instance id
string$sortbysort by this element (id, timemodified, timestart or timeend)
string$sortdirectionsort direction: ASC or DESC
int$pagepage number
int$perpageitems per page
Return values
arraythe forum discussion details including warnings
Since
Moodle 2.8

◆ get_forum_discussions_paginated_parameters()

static mod_forum_external::get_forum_discussions_paginated_parameters ( )
static

Describes the parameters for get_forum_discussions_paginated.

Deprecated:
since 3.7
Return values
external_function_parameters
Since
Moodle 2.8

◆ get_forum_discussions_paginated_returns()

static mod_forum_external::get_forum_discussions_paginated_returns ( )
static

Describes the get_forum_discussions_paginated return value.

Deprecated:
since 3.7
Return values
external_single_structure
Since
Moodle 2.8

◆ get_forum_discussions_parameters()

static mod_forum_external::get_forum_discussions_parameters ( )
static

Describes the parameters for get_forum_discussions.

Return values
external_function_parameters
Since
Moodle 3.7

◆ get_forum_discussions_returns()

static mod_forum_external::get_forum_discussions_returns ( )
static

Describes the get_forum_discussions return value.

Return values
external_single_structure
Since
Moodle 3.7

◆ get_forums_by_courses()

static mod_forum_external::get_forums_by_courses (   $courseids = array())
static

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

Parameters
array$courseidsthe course ids
Return values
arraythe forum details
Since
Moodle 2.5

◆ get_forums_by_courses_parameters()

static mod_forum_external::get_forums_by_courses_parameters ( )
static

Describes the parameters for get_forum.

Return values
external_function_parameters
Since
Moodle 2.5

◆ get_forums_by_courses_returns()

static mod_forum_external::get_forums_by_courses_returns ( )
static

Describes the get_forum return value.

Return values
external_single_structure
Since
Moodle 2.5

◆ prepare_draft_area_for_post()

static mod_forum_external::prepare_draft_area_for_post (   $postid,
  $area,
  $draftitemid = 0,
  $filestokeep = [] 
)
static

Prepares a draft area for editing a post.

Parameters
int$postidpost to prepare the draft area for
string$areaarea to prepare attachment or post
int$draftitemidthe draft item id to use. 0 to generate a new one.
array$filestokeeponly keep these files in the draft file area. Empty for keeping all.
Return values
arrayof files in the area, the area options and the draft item id
Since
Moodle 3.8
Exceptions
moodle_exception

◆ prepare_draft_area_for_post_parameters()

static mod_forum_external::prepare_draft_area_for_post_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.8

◆ prepare_draft_area_for_post_returns()

static mod_forum_external::prepare_draft_area_for_post_returns ( )
static

Returns description of method result value.

Return values
external_description
Since
Moodle 3.8

◆ set_context_restriction()

static external_api::set_context_restriction (   $context)
staticinherited

Set context restriction for all following subsequent function calls.

Parameters
stdClass$contextthe context restriction
Since
Moodle 2.0

◆ set_lock_state()

static mod_forum_external::set_lock_state (   $forumid,
  $discussionid,
  $targetstate 
)
static

Set the lock state.

Parameters
int$forumid
int$discussionid
string$targetstate
Return values
stdClass

◆ set_lock_state_parameters()

static mod_forum_external::set_lock_state_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters

◆ set_lock_state_returns()

static mod_forum_external::set_lock_state_returns ( )
static

Returns description of method result value.

Return values
external_description

◆ set_pin_state()

static mod_forum_external::set_pin_state (   $discussionid,
  $targetstate 
)
static

Set the pin state.

Parameters
int$discussionid
bool$targetstate
Return values
stdClass

◆ set_pin_state_parameters()

static mod_forum_external::set_pin_state_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters

◆ set_pin_state_returns()

static mod_forum_external::set_pin_state_returns ( )
static

Returns description of method result value.

Return values
external_single_structure

◆ set_subscription_state()

static mod_forum_external::set_subscription_state (   $forumid,
  $discussionid,
  $targetstate 
)
static

Set the subscription state.

Parameters
int$forumid
int$discussionid
bool$targetstate
Return values
stdClass

◆ set_subscription_state_parameters()

static mod_forum_external::set_subscription_state_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters

◆ set_subscription_state_returns()

static mod_forum_external::set_subscription_state_returns ( )
static

Returns description of method result value.

Return values
external_description

◆ 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$secondsmax expected time the next operation needs
Since
Moodle 2.0

◆ toggle_favourite_state()

static mod_forum_external::toggle_favourite_state (   $discussionid,
  $targetstate 
)
static

Toggle the favouriting value for the discussion provided.

Parameters
int$discussionidThe discussion we need to favourite
bool$targetstateThe state of the favourite value
Return values
arrayThe exported discussion

◆ toggle_favourite_state_parameters()

static mod_forum_external::toggle_favourite_state_parameters ( )
static

Defines the parameters for the toggle_favourite_state method.

Return values
external_function_parameters

◆ toggle_favourite_state_returns()

static mod_forum_external::toggle_favourite_state_returns ( )
static

Returns description of method result value.

Return values
external_description
Since
Moodle 3.0

◆ update_discussion_post()

static mod_forum_external::update_discussion_post (   $postid,
  $subject = '',
  $message = '',
  $messageformat = FORMAT_HTML,
  $options = [] 
)
static

Updates a post or a discussion post topic.

Parameters
int$postidpost to be updated, it can be a discussion topic post.
string$subjectupdated post subject
string$messageupdated post message (HTML assumed if messageformat is not provided)
int$messageformatThe format of the message, defaults to FORMAT_HTML
array$optionsdifferent configuration options for the post to be updated.
Return values
arrayof warnings and the status (true if the post/discussion was deleted)
Since
Moodle 3.8
Exceptions
moodle_exception
Todo:
support more options: timed posts, groups change and tags.

◆ update_discussion_post_parameters()

static mod_forum_external::update_discussion_post_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 3.8

◆ update_discussion_post_returns()

static mod_forum_external::update_discussion_post_returns ( )
static

Returns description of method result value.

Return values
external_description
Since
Moodle 3.8

◆ 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$descriptiondescription of parameters
mixed$paramsthe actual parameters
Return values
mixedparams with added defaults for optional items, invalid_parameters_exception thrown if any problem found
Since
Moodle 2.0

◆ view_forum()

static mod_forum_external::view_forum (   $forumid)
static

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

Parameters
int$forumidthe forum instance id
Return values
arrayof warnings and status result
Since
Moodle 2.9
Exceptions
moodle_exception

◆ view_forum_discussion()

static mod_forum_external::view_forum_discussion (   $discussionid)
static

Trigger the discussion viewed event.

Parameters
int$discussionidthe discussion id
Return values
arrayof warnings and status result
Since
Moodle 2.9
Exceptions
moodle_exception

◆ view_forum_discussion_parameters()

static mod_forum_external::view_forum_discussion_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 2.9

◆ view_forum_discussion_returns()

static mod_forum_external::view_forum_discussion_returns ( )
static

Returns description of method result value.

Return values
external_description
Since
Moodle 2.9

◆ view_forum_parameters()

static mod_forum_external::view_forum_parameters ( )
static

Returns description of method parameters.

Return values
external_function_parameters
Since
Moodle 2.9

◆ view_forum_returns()

static mod_forum_external::view_forum_returns ( )
static

Returns description of method result value.

Return values
external_description
Since
Moodle 2.9

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