AppSuite:Capabilities - Revision history

WolfgangRosenauer at 15:55, 26 February 2020

2020-02-26T15:55:58Z

← Older revision		Revision as of 15:55, 26 February 2020
Line 66:		Line 66:
	== Query capabilities in the UI ==		== Query capabilities in the UI ==
	require(['io.ox/core/capabilities'], function (cap) { if cap.has('[myproduct]' { ... } );		require(['io.ox/core/capabilities'], function (cap) { if cap.has('[myproduct]' { ... } );

			To just list all:

			_(ox.serverConfig.capabilities).pluck("id").sort();

	== Require the capabilities in your UI manifest file ==		== Require the capabilities in your UI manifest file ==

Ioannis.chouklis: /* Query capabilities via the HTTP API */

2018-02-08T08:29:26Z

Query capabilities via the HTTP API

← Older revision		Revision as of 08:29, 8 February 2018
Line 61:		Line 61:

	Here <tt>id</tt> is the name of the capability.		Here <tt>id</tt> is the name of the capability.

			Note that the LinkedIn support was removed since 7.10.0

	== Query capabilities in the UI ==		== Query capabilities in the UI ==

Martin.schneider: US 97798972, remove everything related to facebook

2015-07-07T12:59:22Z

US 97798972, remove everything related to facebook

← Older revision		Revision as of 12:59, 7 July 2015
Line 58:		Line 58:
	GET /appsuite/api/capabilities?action=all&session=991fd40f635b45...		GET /appsuite/api/capabilities?action=all&session=991fd40f635b45...
	Response:		Response:
	{"data":[{"id":"oauth","attributes":{}},{"id":"webmail","attributes":{}},{"id":"document_preview","attributes":{}},{"id":"printing","attributes":{}},{"id":"spreadsheet","attributes":{}},{"id":"gab","attributes":{}},{"id":"multiple_mail_accounts","attributes":{}},{"id":"publication","attributes":{}},{"id":"rss_bookmarks","attributes":{}},{"id":"linkedin","attributes":{}},{"id":"filestore","attributes":{}},{"id":"ical","attributes":{}},{"id":"rt","attributes":{}},{"id":"olox20","attributes":{}},{"id":"forum","attributes":{}},{"id":"active_sync","attributes":{}},{"id":"conflict_handling","attributes":{}},{"id":"rss_portal","attributes":{}},{"id":"oxupdater","attributes":{}},{"id":"infostore","attributes":{}},{"id":"contacts","attributes":{}},{"id":"collect_email_addresses~~","attributes":{}},{"id":"facebook~~","attributes":{}},{"id":"drive","attributes":{}},{"id":"rss","attributes":{}},{"id":"pinboard_write_access","attributes":{}},{"id":"mobility","attributes":{}},{"id":"calendar","attributes":{}},{"id":"participants_dialog","attributes":{}},{"id":"edit_public_folders","attributes":{}},{"id":"text","attributes":{}},{"id":"groupware","attributes":{}},{"id":"msisdn","attributes":{}},{"id":"carddav","attributes":{}},{"id":"tasks","attributes":{}},{"id":"portal","attributes":{}},{"id":"mailfilter","attributes":{}},{"id":"read_create_shared_folders","attributes":{}},{"id":"vcard","attributes":{}},{"id":"pim","attributes":{}},{"id":"caldav","attributes":{}},{"id":"projects","attributes":{}},{"id":"usm","attributes":{}},{"id":"webdav","attributes":{}},{"id":"dev","attributes":{}},{"id":"delegate_tasks","attributes":{}},{"id":"freebusy","attributes":{}},{"id":"subscription","attributes":{}},{"id":"linkedinPlus","attributes":{}},{"id":"autologin","attributes":{}},{"id":"webdav_xml","attributes":{}},{"id":"twitter","attributes":{}}]}		{"data":[{"id":"oauth","attributes":{}},{"id":"webmail","attributes":{}},{"id":"document_preview","attributes":{}},{"id":"printing","attributes":{}},{"id":"spreadsheet","attributes":{}},{"id":"gab","attributes":{}},{"id":"multiple_mail_accounts","attributes":{}},{"id":"publication","attributes":{}},{"id":"rss_bookmarks","attributes":{}},{"id":"linkedin","attributes":{}},{"id":"filestore","attributes":{}},{"id":"ical","attributes":{}},{"id":"rt","attributes":{}},{"id":"olox20","attributes":{}},{"id":"forum","attributes":{}},{"id":"active_sync","attributes":{}},{"id":"conflict_handling","attributes":{}},{"id":"rss_portal","attributes":{}},{"id":"oxupdater","attributes":{}},{"id":"infostore","attributes":{}},{"id":"contacts","attributes":{}},{"id":"collect_email_addresses","attributes":{}},{"id":"drive","attributes":{}},{"id":"rss","attributes":{}},{"id":"pinboard_write_access","attributes":{}},{"id":"mobility","attributes":{}},{"id":"calendar","attributes":{}},{"id":"participants_dialog","attributes":{}},{"id":"edit_public_folders","attributes":{}},{"id":"text","attributes":{}},{"id":"groupware","attributes":{}},{"id":"msisdn","attributes":{}},{"id":"carddav","attributes":{}},{"id":"tasks","attributes":{}},{"id":"portal","attributes":{}},{"id":"mailfilter","attributes":{}},{"id":"read_create_shared_folders","attributes":{}},{"id":"vcard","attributes":{}},{"id":"pim","attributes":{}},{"id":"caldav","attributes":{}},{"id":"projects","attributes":{}},{"id":"usm","attributes":{}},{"id":"webdav","attributes":{}},{"id":"dev","attributes":{}},{"id":"delegate_tasks","attributes":{}},{"id":"freebusy","attributes":{}},{"id":"subscription","attributes":{}},{"id":"linkedinPlus","attributes":{}},{"id":"autologin","attributes":{}},{"id":"webdav_xml","attributes":{}},{"id":"twitter","attributes":{}}]}

	Here <tt>id</tt> is the name of the capability.		Here <tt>id</tt> is the name of the capability.

Norbert.weinhold: /* Set a capability */

2014-03-14T13:59:15Z

Set a capability

← Older revision		Revision as of 13:59, 14 March 2014
Line 19:		Line 19:
	First, disable it for everyone as default (or enable it for everyone, depending on what your aim is).		First, disable it for everyone as default (or enable it for everyone, depending on what your aim is).

	In <tt>/opt/open-xchange/[myproduct].properties</tt>:		In <tt>/opt/open-xchange/etc/[myproduct].properties</tt>:

	com.openexchange.capability.[myproduct]=false # off for everyone		com.openexchange.capability.[myproduct]=false # off for everyone
Line 48:		Line 48:

	premium:		premium:
	com.openexchange~~.config~~.capability.[myproduct]: true		com.openexchange.capability.[myproduct]: true
	withTags: premium		withTags: premium

Cutmasta: /* What are capabilities? */

2014-01-10T10:51:51Z

What are capabilities?

← Older revision		Revision as of 10:51, 10 January 2014
Line 11:		Line 11:
	'''Usecase'''		'''Usecase'''

	You write a new UI app or plugin (chat module, for example) and want to make sure that only a specific set of users or contexts within the system ~~can~~ use it.		You write a new UI app or plugin (chat module, for example) and in addition, you want to make sure that only a specific set of users or contexts within the system are allowed to use it.

	''Example:'' Your chat app should only be available after a user has bought it in your online shop. To do so, you will need to implement the capabilities logic within your UI app or plugin and restrict it to a user or context marked accordingly (called "premium" in further examples).		''Example:'' Your chat app should only be available after a user has bought it in your online shop. To do so, you will need to implement the capabilities logic within your UI app or plugin and restrict it to a user or context marked accordingly (called "premium" in further examples).

Cutmasta: /* What are capabilities? */

2014-01-10T10:51:18Z

What are capabilities?

← Older revision		Revision as of 10:51, 10 January 2014
Line 11:		Line 11:
	'''Usecase'''		'''Usecase'''

	You write a new UI app or plugin (chat module, for example) and want to make sure that only a specific set of users or contexts within the system can it.		You write a new UI app or plugin (chat module, for example) and want to make sure that only a specific set of users or contexts within the system can use it.

	''Example:'' Your chat app should only be available after a user has bought it in your online shop. To do so, you will need to implement the capabilities logic within your UI app or plugin and restrict it to a user or context marked accordingly (called "premium" in further examples).		''Example:'' Your chat app should only be available after a user has bought it in your online shop. To do so, you will need to implement the capabilities logic within your UI app or plugin and restrict it to a user or context marked accordingly (called "premium" in further examples).

Cutmasta: /* Require the capabilities in your UI manifest */

2014-01-10T08:43:35Z

Require the capabilities in your UI manifest

← Older revision		Revision as of 08:43, 10 January 2014
Line 65:		Line 65:
	require(['io.ox/core/capabilities'], function (cap) { if cap.has('[myproduct]' { ... } );		require(['io.ox/core/capabilities'], function (cap) { if cap.has('[myproduct]' { ... } );

	== Require the capabilities in your UI manifest ==		== Require the capabilities in your UI manifest file ==
	{		{
	namespace: ...		namespace: ...
Line 71:		Line 71:
	}		}

	~~The~~ plugin will only be loaded if the capability is set for ~~the~~ specific user.		Now your plugin will only be loaded if the capability '[myproduct]' is set for a specific user, context, context set.


	== Testing the capabilities ==		== Testing the capabilities ==

Cutmasta: /* Testing the capabilities */

2014-01-10T08:41:22Z

Testing the capabilities

← Older revision		Revision as of 08:41, 10 January 2014
Line 80:		Line 80:
	Add the following parameter to your AppSuite URL in the browser to activate:		Add the following parameter to your AppSuite URL in the browser to activate:

	&cap=[myproduct]		&cap=[myproduct]

	or use		or use

Cutmasta: /* Testing the capabilities */

2014-01-10T08:38:36Z

Testing the capabilities

← Older revision		Revision as of 08:38, 10 January 2014
Line 76:		Line 76:
	== Testing the capabilities ==		== Testing the capabilities ==

	* For testing purposes use ~~these 2 easy steps:~~		* For testing purposes use an URL parameter to test capabilities.

	+ Add the "&cap=[myproduct]" URL ~~parameter in your AppSuite browser tab~~		Add the following parameter to your AppSuite URL in the browser to activate:
	~~+ Reload~~ the UI to temporarly test/enable a capability.
			&cap=[myproduct]

			or use

			&disableFeature=[myproduct]

			to disable a certain capability.

			In general, after adding those URL parameters, you need to reload the UI to temporarly test/enable the set capability.

	== Further informations ==		== Further informations ==

Cutmasta: /* Further informations */

2014-01-10T08:35:10Z

Further informations

← Older revision		Revision as of 08:35, 10 January 2014
Line 83:		Line 83:
	== Further informations ==		== Further informations ==
	* See the dedicated wiki page of the [[ConfigCascade]] mechanism for more details.		* See the dedicated wiki page of the [[ConfigCascade]] mechanism for more details.
	* Similarly, you can disable a capability with &disableFeature=[myproduct]
	* If you want to know about existing capabilities and the way they are used for upsell, see [[AppSuite:Upsell#Capabilities_and_Upsell_triggers]]		* If you want to know about existing capabilities and the way they are used for upsell, see [[AppSuite:Upsell#Capabilities_and_Upsell_triggers]]