AppSuite:Writing a simple application with embedded iframe - Revision history

Khgras at 09:24, 22 May 2017

2017-05-22T09:24:28Z

← Older revision		Revision as of 09:24, 22 May 2017
Line 1:		Line 1:
	~~<!-- !!! -->~~		The content on this page has moved to https://documentation.open-xchange.com/latest/ui/customize/app/simple-application-iframe.html
	~~<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION~~: ~~wd/frontend~~/~~web~~/documentation -->
	~~<!-- !!! -~~->

	~~{{Stability~~-~~experimental}}~~		Note: Open-Xchange is in the process of migrating all its technical documentation to a new and improved documentation system (documentation.open-xchange.com). Please note as the migration takes place more information will be available on the new system and less on this system. Thank you for your understanding during this period of transition.

	~~<div class="title">Writing a simple application with an embedded iframe and launcher link</div>~~

	~~__TOC__~~

	~~==Provide an iframe for the content area (since 7.8)==~~

	~~Developing an app with an iframe for the content area~~ is ~~quite easy.~~
	~~All it needs is a manifest file (manifest.json) and the app file (main.js).~~

	~~Both should be located in an designated folder~~ in the ~~apps folder.~~
	~~In this example the namespace 'com.example' will be used. (apps/com.example)~~

	~~To make use~~ of ~~the provided helper function io.ox/core/tk/iframe has~~ to ~~be required in the define section.~~

	~~<pre class="language-javascript">~~
	~~define('com.example/main', [~~
	~~'io.ox/core/tk/iframe',~~
	~~'gettext!com.example'~~
	~~], function (createIframeApp, gt) {~~

	~~'use strict';~~

	~~var iframeApp = createIframeApp({~~
	~~name: 'com.example', // the name of the app~~
	~~title: gt('Hallo, World!'), // the title of the app as used in the launcher~~
	~~pageTitle: gt('Hallo, World!'), // the page Title~~
	~~url: 'https://www.example.com/', // the domain which should be used for the iframe~~
	~~acquireToken: true // generates~~ a ~~login token~~ and ~~appends it to the supplied url as ox_token parameter~~
	~~});~~

	~~return {~~
	~~getApp: iframeApp.getApp~~
	};
	~~});~~
	~~</pre>~~

	~~The provided token can be used to generate a valid session with the [https://~~documentation.open-xchange.com~~/latest/middleware/http_api.html HTTP API (redeem token login process~~)].

	~~==Add app to~~ the ~~launcher (since 7.8)==~~

	~~To display an app in the launcher, the property 'topbar': true has to~~ be ~~set in~~ the ~~manifest~~.~~json file of the app.~~
	~~To define the order, use the index value in the manifest.json file.~~

	~~<pre class="language-javascript">~~
	{
	~~"title": "Hallo, World!",~~
	~~"company": "external",~~
	~~"icon": "/images/icon.png",~~
	~~"category": "Dev",~~
	~~"settings": false,~~
	~~"index": 10000,~~
	~~"topbar": true~~
	}
	~~</pre>~~

	~~==Reorder / remove apps from launcher (since 7.6)==~~

	~~To define a custom order~~ of ~~the apps or remove an app from the laucher the server-side setting topbar/order can be used to provide a comma-separated list of apps which should be available in the launcher.~~

	~~Example: io.ox/core//topbar/order=io.ox/mail,com.example,io.ox/contacts,io.ox/portal~~

	~~An app which is not listed here, is not available in the launcher anymore~~.

Martin.schneider: Move to https://documentation.open-xchange.com/

2016-06-30T08:03:45Z

Move to https://documentation.open-xchange.com/

← Older revision		Revision as of 08:03, 30 June 2016
Line 41:		Line 41:
	</pre>		</pre>

	The provided token can be used to generate a valid session with the [~~[HTTP_API#Redeem_Token_~~.~~28since_7~~.4.~~0.29 \|~~ redeem token login process]].		The provided token can be used to generate a valid session with the [https://documentation.open-xchange.com/latest/middleware/http_api.html HTTP API (redeem token login process)].

	==Add app to the launcher (since 7.8)==		==Add app to the launcher (since 7.8)==

Frank.paczynski at 14:06, 8 February 2016

2016-02-08T14:06:15Z

← Older revision		Revision as of 14:06, 8 February 2016
Line 1:		Line 1:
			<!-- !!! -->
			<!-- PLEASE APPLY CHANGES ONLY TO THE NEW TECHNICAL DOCUMENTATION: wd/frontend/web/documentation -->
			<!-- !!! -->

	{{Stability-experimental}}		{{Stability-experimental}}

Christoph.kopp: /* Provide an iframe for the content area (since 7.8) */

2015-05-21T05:52:17Z

Provide an iframe for the content area (since 7.8)

← Older revision		Revision as of 05:52, 21 May 2015
Line 37:		Line 37:
	</pre>		</pre>

	The provided token can be used to generate a valid session with the ~~redeem token login process~~ [[HTTP_API#Redeem_Token_.28since_7.4.0.29 \| redeem token login process]].		The provided token can be used to generate a valid session with the [[HTTP_API#Redeem_Token_.28since_7.4.0.29 \| redeem token login process]].

	==Add app to the launcher (since 7.8)==		==Add app to the launcher (since 7.8)==

Christoph.kopp: /* Provide an iframe for the content area (since 7.8) */

2015-05-21T05:51:01Z

Provide an iframe for the content area (since 7.8)

← Older revision		Revision as of 05:51, 21 May 2015
Line 36:		Line 36:
	});		});
	</pre>		</pre>

			The provided token can be used to generate a valid session with the redeem token login process [[HTTP_API#Redeem_Token_.28since_7.4.0.29 \| redeem token login process]].

	==Add app to the launcher (since 7.8)==		==Add app to the launcher (since 7.8)==

Christoph.kopp: /* Provide an iframe for the content area (since 7.8) */

2015-05-20T07:53:01Z

Provide an iframe for the content area (since 7.8)

← Older revision		Revision as of 07:53, 20 May 2015
Line 28:		Line 28:
	pageTitle: gt('Hallo, World!'), // the page Title		pageTitle: gt('Hallo, World!'), // the page Title
	url: 'https://www.example.com/', // the domain which should be used for the iframe		url: 'https://www.example.com/', // the domain which should be used for the iframe
	acquireToken: true // generates a login token and appends it to the supplied url		acquireToken: true // generates a login token and appends it to the supplied url as ox_token parameter
	});		});

Christoph.kopp: /* Provide an iframe for the content area (since 7.8) */

2015-05-13T11:49:59Z

Provide an iframe for the content area (since 7.8)

← Older revision		Revision as of 11:49, 13 May 2015
Line 27:		Line 27:
	title: gt('Hallo, World!'), // the title of the app as used in the launcher		title: gt('Hallo, World!'), // the title of the app as used in the launcher
	pageTitle: gt('Hallo, World!'), // the page Title		pageTitle: gt('Hallo, World!'), // the page Title
	~~domain~~: 'https://www.example.com/', // the domain which should be used for the iframe		url: 'https://www.example.com/', // the domain which should be used for the iframe
	~~cssNamespace: 'hallo_world', // a css class used for namespacing,~~
	acquireToken: true // generates a login token and appends it to the supplied url		acquireToken: true // generates a login token and appends it to the supplied url
	});		});

Christoph.kopp at 10:44, 13 May 2015

2015-05-13T10:44:40Z

← Older revision		Revision as of 10:44, 13 May 2015
Line 1:		Line 1:
	{{Stability-experimental}}		{{Stability-experimental}}

	<div class="title">Writing a simple application with an embedded iframe and a launcher link</div>		<div class="title">Writing a simple application with an embedded iframe and launcher link</div>

	__TOC__		__TOC__

Christoph.kopp at 10:39, 13 May 2015

2015-05-13T10:39:37Z

← Older revision		Revision as of 10:39, 13 May 2015
Line 1:		Line 1:
	{{Stability-experimental}}		{{Stability-experimental}}

	<div class="title">Writing a simple application with an embedded iframe</div>		<div class="title">Writing a simple application with an embedded iframe and a launcher link</div>

	__TOC__		__TOC__

Christoph.kopp: /* Provide an iframe for the content area */

2015-05-13T10:37:38Z

Provide an iframe for the content area

← Older revision		Revision as of 10:37, 13 May 2015
Line 5:		Line 5:
	__TOC__		__TOC__

	==Provide an iframe for the content area==		==Provide an iframe for the content area (since 7.8)==

	Developing an app with an iframe for the content area is quite easy.		Developing an app with an iframe for the content area is quite easy.