Using Joomla Ajax Interface - Revision history

Robbiej: Added deprecation notice and link to Joomla Manual

2024-11-27T10:30:03Z

Added deprecation notice and link to Joomla Manual

← Older revision		Revision as of 10:30, 27 November 2024
Line 1:		Line 1:
			{{Warning\|This page has been superseded and is no longer maintained. Please go to [https://manual.joomla.org/docs/general-concepts/javascript/com-ajax/ Joomla Manual ] instead}}

	<noinclude><languages /></noinclude>		<noinclude><languages /></noinclude>
	<noinclude>{{Joomla version\|version=3.2\|time=and after\|comment=<translate><!--T:37-->		<noinclude>{{Joomla version\|version=3.2\|time=and after\|comment=<translate><!--T:37-->

Cmb: Several markup changes.

2022-11-30T18:06:47Z

Several markup changes.

← Older revision		Revision as of 18:06, 30 November 2022
Line 3:		Line 3:
	series</translate>}}</noinclude>		series</translate>}}</noinclude>
	{{-}}		{{-}}
	<translate>==What is The Joomla Ajax Interface (com_ajax)== <!--T:1--></translate>		<translate>==What is The Joomla Ajax Interface (''com_ajax'')== <!--T:1--></translate>
	<translate><!--T:2-->		<translate><!--T:2-->
	A slim, extensible component to act as an entry point for HTTP requests for stand alone modules and plugins, thus allowing for the potential of Ajax functionality in them. ~~Com_ajax~~ is generally used when you are not the developer of the component that the module or plugin is interacting with.</translate>		A slim, extensible component to act as an entry point for HTTP requests for stand alone modules and plugins, thus allowing for the potential of Ajax functionality in them. ''com_ajax ''is generally used when you are not the developer of the component that the module or plugin is interacting with.</translate>

	<translate><!--T:3-->		<translate><!--T:3-->
	'''NOTE''': If you are a component developer, you do not need to use com_ajax to implement Ajax functionality in it. You can do so directly in your component.</translate>		'''NOTE''' If you are a component developer, you do not need to use ''com_ajax'' to implement Ajax functionality in it. You can do so directly in your component.</translate>

	<translate><!--T:4-->		<translate><!--T:4-->
Line 20:		Line 20:
	<translate>===Required=== <!--T:6--></translate>		<translate>===Required=== <!--T:6--></translate>

	*~~<code>~~option=com_ajax~~</code>~~		*''option=com_ajax''
	*~~<code>~~[module\|plugin]=name~~</code>~~		*''[module\|plugin]=name''
	*~~<code>~~format=[json\|debug\|raw]~~</code>~~		*''format=[json\|debug\|raw]''

	<translate>===Optional=== <!--T:7--></translate>		<translate>===Optional=== <!--T:7--></translate>
	*~~<code>~~method=[custom fragment]~~</code>~~ <translate><!--T:8-->		*''method=[custom fragment]'' <translate><!--T:8-->
	defaults to ~~<code>~~get~~</code>~~ if omitted.</translate>		defaults to ''get'' if omitted.</translate>

	<translate>===Overview=== <!--T:9--></translate>		<translate>===Overview=== <!--T:9--></translate>
	<translate><!--T:10-->		<translate><!--T:10-->
	All requests begin with ~~<code>~~?option=com_ajax~~</code>~~, which calls this extension, and must indicate the type of extension to call, and the data format to be returned.		All requests begin with ''?option=com_ajax'', which calls this extension, and must indicate the type of extension to call, and the data format to be returned.

	<!--T:11-->		<!--T:11-->
Line 36:		Line 36:

	<translate><!--T:12-->		<translate><!--T:12-->
	For example, a request to ~~<code>~~?option=com_ajax&module=session~~</code>~~ would call ~~<code>~~mod_session~~</code>~~ with results returned in the default format. In contrast,~~<code>~~?option=com_ajax&plugin=session&format=json~~</code>~~ would trigger the ~~<code>~~onAjaxSession~~</code>~~ plugin group with results returned in JSON.</translate>		For example, a request to ''?option=com_ajax&module=session'' would call ''mod_session'' with results returned in the default format. In contrast,''?option=com_ajax&plugin=session&format=json'' would trigger the ''onAjaxSession'' plugin group with results returned in JSON.</translate>

	<translate>==Module Support== <!--T:13--></translate>		<translate>==Module Support== <!--T:13--></translate>
Line 43:		Line 43:

	<translate><!--T:15-->		<translate><!--T:15-->
	Module support is accomplished by calling a method in the module's ~~<code>~~helper.php~~</code>~~ file.</translate>		Module support is accomplished by calling a method in the module's ''helper.php'' file.</translate>

	<translate>===Details=== <!--T:16--></translate>		<translate>===Details=== <!--T:16--></translate>

	<translate><!--T:17-->		<translate><!--T:17-->
	Module requests must include the ~~<code>~~module~~</code>~~ variable in the URL, paired with the name of the module (i.e. ~~<code>~~module=session~~</code>~~ for ~~<code>~~mod_session~~</code>~~).</translate>		Module requests must include the ''module'' variable in the URL, paired with the name of the module (i.e. ''module=session'' for ''mod_session'').</translate>

	<translate><!--T:18-->		<translate><!--T:18-->
Line 54:		Line 54:

	<!--T:19-->		<!--T:19-->
	*The name of the directory to check for the helper file, e.g. ~~<code>~~/modules/mod_session/helper.php~~</code>~~		*The name of the directory to check for the helper file, e.g. ''/modules/mod_session/helper.php''

	<!--T:20-->		<!--T:20-->
	*The class name to call, e.g. ~~<code>~~modSessionHelper~~</code>~~</translate>		*The class name to call, e.g. ''modSessionHelper''</translate>

	<translate><!--T:21-->		<translate><!--T:21-->
	Optionally, the ~~<code>~~method~~</code>~~ variable may be included to override the default method prefix of ~~<code>~~get~~</code>~~.</translate>		Optionally, the ''method'' variable may be included to override the default method prefix of ''get''.</translate>

	:<translate><!--T:22-->		:<translate><!--T:22-->
	'''NOTE''': All methods must end in ~~<code>~~Ajax~~</code>~~. For example:</translate>		'''NOTE''' All methods must end in ''Ajax''. For example:</translate>
	:~~<code>~~method=mySuperAwesomeMethodToTrigger~~</code>~~ <translate><!--T:23-->		:''method=mySuperAwesomeMethodToTrigger'' <translate><!--T:23-->
	will call</translate> ~~<code>~~mySuperAwesomeMethodToTriggerAjax~~</code>~~		will call</translate> ''mySuperAwesomeMethodToTriggerAjax''

	<translate><!--T:24-->		<translate><!--T:24-->
Line 75:		Line 75:

	<!--T:27-->		<!--T:27-->
	Plugin support is accomplished by triggering the ~~<code>~~onAjax[Name]~~</code>~~ plugin event.</translate>		Plugin support is accomplished by triggering the ''onAjax[Name]'' plugin event.</translate>

	<translate>===Details=== <!--T:28-->		<translate>===Details=== <!--T:28-->

	<!--T:29-->		<!--T:29-->
	Plugin requests must include the ~~<code>~~plugin~~</code>~~ variable in the URL, paired with the name of the plugin event, e.g. ~~<code>~~plugin=session~~</code>~~ for ~~<code>~~onAjaxSession~~</code>~~.</translate>		Plugin requests must include the ''plugin'' variable in the URL, paired with the name of the plugin event, e.g. ''plugin=session'' for ''onAjaxSession''.</translate>

	<translate><!--T:30-->		<translate><!--T:30-->
Line 86:		Line 86:

	<!--T:31-->		<!--T:31-->
	*The plugin class name following the ~~<code>~~plgAjax[Name]~~</code>~~ convention.		*The plugin class name following the ''plgAjax[Name]'' convention.
	*The plugin function name following the ~~<code>~~onAjax[Name]~~</code>~~ convention.		*The plugin function name following the ''onAjax[Name]'' convention.
	*The default plugin group is ~~<code>~~ajax~~</code>~~. You can change it specifying the ~~<code>~~group~~</code>~~ request parameter. (From Joomla! 3.4)		*The default plugin group is ''ajax''. You can change it specifying the ''group'' request parameter. (From Joomla! 3.4)

	<!--T:32-->		<!--T:32-->
Line 96:		Line 96:

	<translate><!--T:34-->		<translate><!--T:34-->
	~~<code>~~format=[json\|debug]~~</code>~~ is an optional argument for the results format:		''format=[json\|debug]'' is an optional argument for the results format:

	<!--T:35-->		<!--T:35-->
	*~~<code>~~json~~</code>~~ for JSON format		*''json'' for JSON format
	*~~<code>~~debug~~</code>~~ for human-readable output of the results.</translate>		*''debug'' for human-readable output of the results.</translate>

	<translate><!--T:36-->		<translate><!--T:36-->

MATsxm: Marked this version for translation

2015-05-26T14:44:53Z

Marked this version for translation

← Older revision		Revision as of 14:44, 26 May 2015
Line 1:		Line 1:
	<noinclude><languages /></noinclude>		<noinclude><languages /></noinclude>
	<noinclude>{{Joomla version\|version=3.2\|time=and after\|comment=<translate>series</translate>}}</noinclude>		<noinclude>{{Joomla version\|version=3.2\|time=and after\|comment=<translate><!--T:37-->
			series</translate>}}</noinclude>
	{{-}}		{{-}}
	<translate>==What is The Joomla Ajax Interface (com_ajax)== <!--T:1--></translate>		<translate>==What is The Joomla Ajax Interface (com_ajax)== <!--T:1--></translate>

MATsxm at 14:44, 26 May 2015

2015-05-26T14:44:41Z

← Older revision		Revision as of 14:44, 26 May 2015
Line 1:		Line 1:
	<noinclude><languages /></noinclude>		<noinclude><languages /></noinclude>
	<noinclude>{{version~~/tutor~~\|3.2}}</noinclude>		<noinclude>{{Joomla version\|version=3.2\|time=and after\|comment=<translate>series</translate>}}</noinclude>
			{{-}}
	<translate>==What is The Joomla Ajax Interface (com_ajax)== <!--T:1--></translate>		<translate>==What is The Joomla Ajax Interface (com_ajax)== <!--T:1--></translate>
	<translate><!--T:2-->		<translate><!--T:2-->
Line 86:		Line 87:
	*The plugin class name following the <code>plgAjax[Name]</code> convention.		*The plugin class name following the <code>plgAjax[Name]</code> convention.
	*The plugin function name following the <code>onAjax[Name]</code> convention.		*The plugin function name following the <code>onAjax[Name]</code> convention.
	*The default plugin group is <code>ajax</code>. You can change it specifying the <code>group</code> request parameter. (From Joomla 3.4)		*The default plugin group is <code>ajax</code>. You can change it specifying the <code>group</code> request parameter. (From Joomla! 3.4)

	<!--T:32-->		<!--T:32-->

Fede91it at 13:27, 26 May 2015

2015-05-26T13:27:37Z

← Older revision		Revision as of 13:27, 26 May 2015
Line 86:		Line 86:
	*The plugin class name following the <code>plgAjax[Name]</code> convention.		*The plugin class name following the <code>plgAjax[Name]</code> convention.
	*The plugin function name following the <code>onAjax[Name]</code> convention.		*The plugin function name following the <code>onAjax[Name]</code> convention.
	*The default plugin group is <code>ajax</code>. You can change it specifying the <code>group</code> request parameter.		*The default plugin group is <code>ajax</code>. You can change it specifying the <code>group</code> request parameter. (From Joomla 3.4)

	<!--T:32-->		<!--T:32-->

Fede91it at 13:27, 26 May 2015

2015-05-26T13:27:11Z

← Older revision		Revision as of 13:27, 26 May 2015
Line 86:		Line 86:
	*The plugin class name following the <code>plgAjax[Name]</code> convention.		*The plugin class name following the <code>plgAjax[Name]</code> convention.
	*The plugin function name following the <code>onAjax[Name]</code> convention.		*The plugin function name following the <code>onAjax[Name]</code> convention.
			*The default plugin group is <code>ajax</code>. You can change it specifying the <code>group</code> request parameter.

	<!--T:32-->		<!--T:32-->

MATsxm: Marked this version for translation

2014-11-09T21:05:12Z

Marked this version for translation

← Older revision		Revision as of 21:05, 9 November 2014
Line 1:		Line 1:
	<noinclude><languages /></noinclude>		<noinclude><languages /></noinclude>
	<noinclude>{{version/tutor\|3.2}}</noinclude>		<noinclude>{{version/tutor\|3.2}}</noinclude>
	<translate>==What is The Joomla Ajax Interface (com_ajax)==</translate>		<translate>==What is The Joomla Ajax Interface (com_ajax)== <!--T:1--></translate>
	<translate>A slim, extensible component to act as an entry point for HTTP requests for stand alone modules and plugins, thus allowing for the potential of Ajax functionality in them. Com_ajax is generally used when you are not the developer of the component that the module or plugin is interacting with.</translate>		<translate><!--T:2-->
			A slim, extensible component to act as an entry point for HTTP requests for stand alone modules and plugins, thus allowing for the potential of Ajax functionality in them. Com_ajax is generally used when you are not the developer of the component that the module or plugin is interacting with.</translate>

	<translate>'''NOTE''': If you are a component developer, you do not need to use com_ajax to implement Ajax functionality in it. You can do so directly in your component.</translate>		<translate><!--T:3-->
			'''NOTE''': If you are a component developer, you do not need to use com_ajax to implement Ajax functionality in it. You can do so directly in your component.</translate>

	<translate>Examples of use cases include, but are not limited to:		<translate><!--T:4-->
			Examples of use cases include, but are not limited to:
	*A module that retrieves data from an external API		*A module that retrieves data from an external API
	*A module that interacts with a component that you did not develop		*A module that interacts with a component that you did not develop
	*A plugin that implement API like functionality to allow consumption of data from your site</translate>		*A plugin that implement API like functionality to allow consumption of data from your site</translate>

	<translate>==Anatomy of an Ajax Request==</translate>		<translate>==Anatomy of an Ajax Request== <!--T:5--></translate>

	<translate>===Required===</translate>		<translate>===Required=== <!--T:6--></translate>

	*<code>option=com_ajax</code>		*<code>option=com_ajax</code>
Line 19:		Line 22:
	*<code>format=[json\|debug\|raw]</code>		*<code>format=[json\|debug\|raw]</code>

	<translate>===Optional===</translate>		<translate>===Optional=== <!--T:7--></translate>
	*<code>method=[custom fragment]</code> <translate>defaults to <code>get</code> if omitted.</translate>		*<code>method=[custom fragment]</code> <translate><!--T:8-->
			defaults to <code>get</code> if omitted.</translate>

	<translate>===Overview===</translate>		<translate>===Overview=== <!--T:9--></translate>
	<translate>All requests begin with <code>?option=com_ajax</code>, which calls this extension, and must indicate the type of extension to call, and the data format to be returned.		<translate><!--T:10-->
			All requests begin with <code>?option=com_ajax</code>, which calls this extension, and must indicate the type of extension to call, and the data format to be returned.

			<!--T:11-->
	Additional variables and values used by your extension may also be included in the URL.</translate>		Additional variables and values used by your extension may also be included in the URL.</translate>

	<translate>For example, a request to <code>?option=com_ajax&module=session</code> would call <code>mod_session</code> with results returned in the default format. In contrast,<code>?option=com_ajax&plugin=session&format=json</code> would trigger the <code>onAjaxSession</code> plugin group with results returned in JSON.</translate>		<translate><!--T:12-->
			For example, a request to <code>?option=com_ajax&module=session</code> would call <code>mod_session</code> with results returned in the default format. In contrast,<code>?option=com_ajax&plugin=session&format=json</code> would trigger the <code>onAjaxSession</code> plugin group with results returned in JSON.</translate>

	<translate>==Module Support==</translate>		<translate>==Module Support== <!--T:13--></translate>

	<translate>===Summary===</translate>		<translate>===Summary=== <!--T:14--></translate>

	<translate>Module support is accomplished by calling a method in the module's <code>helper.php</code> file.</translate>		<translate><!--T:15-->
			Module support is accomplished by calling a method in the module's <code>helper.php</code> file.</translate>

	<translate>===Details===</translate>		<translate>===Details=== <!--T:16--></translate>

	<translate>Module requests must include the <code>module</code> variable in the URL, paired with the name of the module (i.e. <code>module=session</code> for <code>mod_session</code>).</translate>		<translate><!--T:17-->
			Module requests must include the <code>module</code> variable in the URL, paired with the name of the module (i.e. <code>module=session</code> for <code>mod_session</code>).</translate>

	<translate>This value is also used for:		<translate><!--T:18-->
			This value is also used for:

			<!--T:19-->
	*The name of the directory to check for the helper file, e.g. <code>/modules/mod_session/helper.php</code>		*The name of the directory to check for the helper file, e.g. <code>/modules/mod_session/helper.php</code>

			<!--T:20-->
	*The class name to call, e.g. <code>modSessionHelper</code></translate>		*The class name to call, e.g. <code>modSessionHelper</code></translate>

	<translate>Optionally, the <code>method</code> variable may be included to override the default method prefix of <code>get</code>.</translate>		<translate><!--T:21-->
			Optionally, the <code>method</code> variable may be included to override the default method prefix of <code>get</code>.</translate>

	:<translate>'''NOTE''': All methods must end in <code>Ajax</code>. For example:</translate>		:<translate><!--T:22-->
	:<code>method=mySuperAwesomeMethodToTrigger</code> <translate>will call</translate> <code>mySuperAwesomeMethodToTriggerAjax</code>		'''NOTE''': All methods must end in <code>Ajax</code>. For example:</translate>
			:<code>method=mySuperAwesomeMethodToTrigger</code> <translate><!--T:23-->
			will call</translate> <code>mySuperAwesomeMethodToTriggerAjax</code>

	<translate>The [https://github.com/Joomla-Ajax-Interface/Ajax-Session-Module Ajax Session Module] is an example module that demonstrates this functionality.</translate>		<translate><!--T:24-->
			The [https://github.com/Joomla-Ajax-Interface/Ajax-Session-Module Ajax Session Module] is an example module that demonstrates this functionality.</translate>

	<translate>==Plugin Response==</translate>		<translate>==Plugin Response== <!--T:25--></translate>

	<translate>===Summary===		<translate>===Summary=== <!--T:26-->

			<!--T:27-->
	Plugin support is accomplished by triggering the <code>onAjax[Name]</code> plugin event.</translate>		Plugin support is accomplished by triggering the <code>onAjax[Name]</code> plugin event.</translate>

	<translate>===Details===		<translate>===Details=== <!--T:28-->

			<!--T:29-->
	Plugin requests must include the <code>plugin</code> variable in the URL, paired with the name of the plugin event, e.g. <code>plugin=session</code> for <code>onAjaxSession</code>.</translate>		Plugin requests must include the <code>plugin</code> variable in the URL, paired with the name of the plugin event, e.g. <code>plugin=session</code> for <code>onAjaxSession</code>.</translate>

	<translate>This value is also used for:		<translate><!--T:30-->
			This value is also used for:

			<!--T:31-->
	*The plugin class name following the <code>plgAjax[Name]</code> convention.		*The plugin class name following the <code>plgAjax[Name]</code> convention.
	*The plugin function name following the <code>onAjax[Name]</code> convention.		*The plugin function name following the <code>onAjax[Name]</code> convention.

			<!--T:32-->
	The [https://github.com/Joomla-Ajax-Interface/Ajax-Latest-Articles Ajax Latest Articles plugin] is an example plugin that demonstrates this functionality.</translate>		The [https://github.com/Joomla-Ajax-Interface/Ajax-Latest-Articles Ajax Latest Articles plugin] is an example plugin that demonstrates this functionality.</translate>

	<translate>==Response Format==</translate>		<translate>==Response Format== <!--T:33--></translate>

	<translate><code>format=[json\|debug]</code> is an optional argument for the results format:		<translate><!--T:34-->
			<code>format=[json\|debug]</code> is an optional argument for the results format:

			<!--T:35-->
	*<code>json</code> for JSON format		*<code>json</code> for JSON format
	*<code>debug</code> for human-readable output of the results.</translate>		*<code>debug</code> for human-readable output of the results.</translate>

	<translate>[[Category:AJAX]]		<translate><!--T:36-->
			[[Category:AJAX]]
	[[Category:JavaScript]]		[[Category:JavaScript]]
	[[Category:Development]]</translate>		[[Category:Development]]</translate>

MATsxm at 21:05, 9 November 2014

2014-11-09T21:05:01Z

← Older revision		Revision as of 21:05, 9 November 2014
Line 1:		Line 1:
			<noinclude><languages /></noinclude>
	<noinclude>{{version/tutor\|3.2}}</noinclude>		<noinclude>{{version/tutor\|3.2}}</noinclude>
	==What is The Joomla Ajax Interface (com_ajax)==		<translate>==What is The Joomla Ajax Interface (com_ajax)==</translate>
	A slim, extensible component to act as an entry point for HTTP requests for stand alone modules and plugins, thus allowing for the potential of Ajax functionality in them. Com_ajax is generally used when you are not the developer of the component that the module or plugin is interacting with.		<translate>A slim, extensible component to act as an entry point for HTTP requests for stand alone modules and plugins, thus allowing for the potential of Ajax functionality in them. Com_ajax is generally used when you are not the developer of the component that the module or plugin is interacting with.</translate>

	'''NOTE''': If you are a component developer, you do not need to use com_ajax to implement Ajax functionality in it. You can do so directly in your component.		<translate>'''NOTE''': If you are a component developer, you do not need to use com_ajax to implement Ajax functionality in it. You can do so directly in your component.</translate>

	Examples of use cases include, but are not limited to:		<translate>Examples of use cases include, but are not limited to:
	*A module that retrieves data from an external API		*A module that retrieves data from an external API
	*A module that interacts with a component that you did not develop		*A module that interacts with a component that you did not develop
	*A plugin that implement API like functionality to allow consumption of data from your site		*A plugin that implement API like functionality to allow consumption of data from your site</translate>

	==Anatomy of an Ajax Request==		<translate>==Anatomy of an Ajax Request==</translate>

	===Required===		<translate>===Required===</translate>

	*<code>option=com_ajax</code>		*<code>option=com_ajax</code>
Line 18:		Line 19:
	*<code>format=[json\|debug\|raw]</code>		*<code>format=[json\|debug\|raw]</code>

	===Optional===		<translate>===Optional===</translate>
	*<code>method=[custom fragment]</code> defaults to <code>get</code> if omitted.		*<code>method=[custom fragment]</code> <translate>defaults to <code>get</code> if omitted.</translate>

	===Overview===		<translate>===Overview===</translate>
	All requests begin with <code>?option=com_ajax</code>, which calls this extension, and must indicate the type of extension to call, and the data format to be returned.		<translate>All requests begin with <code>?option=com_ajax</code>, which calls this extension, and must indicate the type of extension to call, and the data format to be returned.

	Additional variables and values used by your extension may also be included in the URL.		Additional variables and values used by your extension may also be included in the URL.</translate>

	For example, a request to <code>?option=com_ajax&module=session</code> would call <code>mod_session</code> with results returned in the default format. In contrast,<code>?option=com_ajax&plugin=session&format=json</code> would trigger the <code>onAjaxSession</code> plugin group with results returned in JSON.		<translate>For example, a request to <code>?option=com_ajax&module=session</code> would call <code>mod_session</code> with results returned in the default format. In contrast,<code>?option=com_ajax&plugin=session&format=json</code> would trigger the <code>onAjaxSession</code> plugin group with results returned in JSON.</translate>

	==Module Support==		<translate>==Module Support==</translate>

	===Summary===		<translate>===Summary===</translate>

	Module support is accomplished by calling a method in the module's <code>helper.php</code> file.		<translate>Module support is accomplished by calling a method in the module's <code>helper.php</code> file.</translate>

	===Details===		<translate>===Details===</translate>

	Module requests must include the <code>module</code> variable in the URL, paired with the name of the module (i.e. <code>module=session</code> for <code>mod_session</code>).		<translate>Module requests must include the <code>module</code> variable in the URL, paired with the name of the module (i.e. <code>module=session</code> for <code>mod_session</code>).</translate>

	This value is also used for:		<translate>This value is also used for:

	*The name of the directory to check for the helper file, e.g. <code>/modules/mod_session/helper.php</code>		*The name of the directory to check for the helper file, e.g. <code>/modules/mod_session/helper.php</code>

	*The class name to call, e.g. <code>modSessionHelper</code>		*The class name to call, e.g. <code>modSessionHelper</code></translate>

	Optionally, the <code>method</code> variable may be included to override the default method prefix of <code>get</code>.		<translate>Optionally, the <code>method</code> variable may be included to override the default method prefix of <code>get</code>.</translate>

	:'''NOTE''': All methods must end in <code>Ajax</code>. For example:		:<translate>'''NOTE''': All methods must end in <code>Ajax</code>. For example:</translate>
	:<code>method=mySuperAwesomeMethodToTrigger</code> will call <code>mySuperAwesomeMethodToTriggerAjax</code>		:<code>method=mySuperAwesomeMethodToTrigger</code> <translate>will call</translate> <code>mySuperAwesomeMethodToTriggerAjax</code>

	The [https://github.com/Joomla-Ajax-Interface/Ajax-Session-Module Ajax Session Module] is an example module that demonstrates this functionality.		<translate>The [https://github.com/Joomla-Ajax-Interface/Ajax-Session-Module Ajax Session Module] is an example module that demonstrates this functionality.</translate>

	==Plugin Response==		<translate>==Plugin Response==</translate>

	===Summary===		<translate>===Summary===

	Plugin support is accomplished by triggering the <code>onAjax[Name]</code> plugin event.		Plugin support is accomplished by triggering the <code>onAjax[Name]</code> plugin event.</translate>

	===Details===		<translate>===Details===

	Plugin requests must include the <code>plugin</code> variable in the URL, paired with the name of the plugin event, e.g. <code>plugin=session</code> for <code>onAjaxSession</code>.		Plugin requests must include the <code>plugin</code> variable in the URL, paired with the name of the plugin event, e.g. <code>plugin=session</code> for <code>onAjaxSession</code>.</translate>

	This value is also used for:		<translate>This value is also used for:

	*The plugin class name following the <code>plgAjax[Name]</code> convention.		*The plugin class name following the <code>plgAjax[Name]</code> convention.
	*The plugin function name following the <code>onAjax[Name]</code> convention.		*The plugin function name following the <code>onAjax[Name]</code> convention.

	The [https://github.com/Joomla-Ajax-Interface/Ajax-Latest-Articles Ajax Latest Articles plugin] is an example plugin that demonstrates this functionality.		The [https://github.com/Joomla-Ajax-Interface/Ajax-Latest-Articles Ajax Latest Articles plugin] is an example plugin that demonstrates this functionality.</translate>

	==Response Format==		<translate>==Response Format==</translate>

	<code>format=[json\|debug]</code> is an optional argument for the results format:		<translate><code>format=[json\|debug]</code> is an optional argument for the results format:

	*<code>json</code> for JSON format		*<code>json</code> for JSON format
	*<code>debug</code> for human-readable output of the results.		*<code>debug</code> for human-readable output of the results.</translate>

	[[Category:AJAX]]		<translate>[[Category:AJAX]]
	[[Category:JavaScript]]		[[Category:JavaScript]]
	[[Category:Development]]		[[Category:Development]]</translate>

Wilsonge: Reverted edits by Wilsonge (talk) to last revision by Jonasfh

2014-05-16T18:10:42Z

Reverted edits by Wilsonge (talk) to last revision by Jonasfh

← Older revision		Revision as of 18:10, 16 May 2014
Line 16:		Line 16:
	*<code>option=com_ajax</code>		*<code>option=com_ajax</code>
	*<code>[module\|plugin]=name</code>		*<code>[module\|plugin]=name</code>
			*<code>format=[json\|debug\|raw]</code>

	===Optional===		===Optional===
	*<code>format=[json\|debug]</code> defaults to raw if omitted.
	*<code>method=[custom fragment]</code> defaults to <code>get</code> if omitted.		*<code>method=[custom fragment]</code> defaults to <code>get</code> if omitted.

Wilsonge: Undo revision 118205 by Jonasfh (talk)

2014-05-16T18:07:14Z

Undo revision 118205 by Jonasfh (talk)

← Older revision		Revision as of 18:07, 16 May 2014
Line 16:		Line 16:
	*<code>option=com_ajax</code>		*<code>option=com_ajax</code>
	*<code>[module\|plugin]=name</code>		*<code>[module\|plugin]=name</code>
	*<code>format=[json\|debug]</code> defaults to raw if omitted.

	===Optional===		===Optional===
			*<code>format=[json\|debug]</code> defaults to raw if omitted.
	*<code>method=[custom fragment]</code> defaults to <code>get</code> if omitted.		*<code>method=[custom fragment]</code> defaults to <code>get</code> if omitted.