External function of getting these services
Signed-off-by: Valentin Popov <info@valentineus.link>
This commit is contained in:
		@@ -98,4 +98,61 @@ class local_webhooks_external extends external_api {
 | 
			
		||||
            )
 | 
			
		||||
        );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns description of method parameters.
 | 
			
		||||
     *
 | 
			
		||||
     * @return \external_function_parameters
 | 
			
		||||
     *
 | 
			
		||||
     * @since Moodle 2.2
 | 
			
		||||
     * @since Moodle 2.9 Options available
 | 
			
		||||
     */
 | 
			
		||||
    public static function get_services_parameters() {
 | 
			
		||||
        return new external_function_parameters(array());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get a list of services.
 | 
			
		||||
     *
 | 
			
		||||
     * @return array
 | 
			
		||||
     *
 | 
			
		||||
     * @since Moodle 2.2
 | 
			
		||||
     * @since Moodle 2.9 Options available
 | 
			
		||||
     *
 | 
			
		||||
     * @throws \dml_exception
 | 
			
		||||
     * @throws \invalid_parameter_exception
 | 
			
		||||
     * @throws \restricted_context_exception
 | 
			
		||||
     */
 | 
			
		||||
    public static function get_services() {
 | 
			
		||||
        $context = context_system::instance();
 | 
			
		||||
        self::validate_context($context);
 | 
			
		||||
 | 
			
		||||
        return local_webhooks_api::get_services();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns description of method result value.
 | 
			
		||||
     *
 | 
			
		||||
     * @return \external_multiple_structure
 | 
			
		||||
     *
 | 
			
		||||
     * @since Moodle 2.2
 | 
			
		||||
     * @since Moodle 2.9 Options available
 | 
			
		||||
     */
 | 
			
		||||
    public static function get_services_returns() {
 | 
			
		||||
        return new external_multiple_structure(
 | 
			
		||||
            new external_single_structure(
 | 
			
		||||
                array(
 | 
			
		||||
                    'id'     => new external_value(PARAM_INT, 'Service ID.'),
 | 
			
		||||
                    'header' => new external_value(PARAM_RAW, 'Type of outgoing header.'),
 | 
			
		||||
                    'name'   => new external_value(PARAM_RAW, 'Name of the service.'),
 | 
			
		||||
                    'point'  => new external_value(PARAM_URL, 'Point of delivery of notifications.'),
 | 
			
		||||
                    'status' => new external_value(PARAM_BOOL, 'Current status of the service.'),
 | 
			
		||||
                    'token'  => new external_value(PARAM_RAW, 'Token for verification of requests.'),
 | 
			
		||||
                    'events' => new external_multiple_structure(
 | 
			
		||||
                        new external_value(PARAM_RAW, 'Event name.'), 'List of events.'
 | 
			
		||||
                    ),
 | 
			
		||||
                )
 | 
			
		||||
            )
 | 
			
		||||
        );
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
		Reference in New Issue
	
	Block a user