Last modified by bougault on 2022/03/02 11:58

From version 16.1
edited by bougault
on 2020/01/21 09:32
Change comment: There is no comment for this version
To version 11.1
edited by allan
on 2019/11/26 17:05
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.bougault
1 +XWiki.allan
Content
... ... @@ -8,7 +8,7 @@
8 8  
9 9  Send an email to [[support@humanbrainproject.eu>>mailto:support@humanbrainproject.eu]] with a short summary of your intentions.
10 10  
11 -The support team will apply the permissions to your user: your account will be [[upgraded with developers privileges>>doc:Collabs.collab-devs.User administration.WebHome]] the next time you will login.
11 +The support team will apply the permissions to your user: your account will be upgraded with developers privileges the next time you will login.
12 12  
13 13  (% class="box infomessage" %)
14 14  (((
... ... @@ -42,7 +42,7 @@
42 42  
43 43  1. In order to install your app, you need to navigate to a collab where you have either the **editor** or **administrator** role.
44 44  1. Click on **Create**. Enter a title for this instance of your app and select **Community App** in the right selector.
45 -1. Click on **Create**. You will be presented with the Community App Catalogue. The app you will see are the public apps and the ones your a maintainer of.
45 +1. Click on **Create**. You will be presented with the Community App Catalogue. The app you will see are the public apps and the ones your a maintainer of.
46 46  1. Select your app and click on **Save and View**.
47 47  
48 48  You should now see how your app looks like within a collab.
... ... @@ -56,30 +56,6 @@
56 56  * ##**clb-doc-name**##: the name of the document where your app instance is installed.
57 57  * ##**clb-drive-id**##: the unique identifier of the drive of the collab. This id is required if you want to fetch or store documents within the drive of the collab.
58 58  
59 -== App settings ==
60 -
61 -The app settings are the values the collab author can modify to change the behaviour of your application within her collab.
62 -
63 -=== Writing settings ===
64 -
65 -The Collaboratory comes with a mechanism to let your app store these settings directly in the Collaboratory.
66 -
67 -In order to do that, your app needs to use the [[postMessage javascript API>>https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage]] to send the settings to store to the Collaboratory:
68 -
69 -{{code language="javascript"}}
70 -window.parent.postMessage({
71 - topic: '/clb/community-app/settings',
72 - data: {
73 - setting1: 'setting 1 value',
74 - setting2: 'setting 2 value',
75 - ...
76 - }}, 'https://wiki.humanbrainproject.eu');
77 -{{/code}}
78 -
79 -=== Fetching settings ===
80 -
81 -The Collaboratory will get the settings from its key/value store and pass them to your app through query parameters.
82 -
83 83  == Creating your OpenID Connect client ==
84 84  
85 85  The steps to create an OpenID Connect client are the following:
... ... @@ -248,3 +248,5 @@
248 248  {{warning}}
249 249  /!\ ** Each time you modify your client, a new registration access token will be generated. You need to track of your token changes to keep access to your client.   **/!\
250 250  {{/warning}}
227 +
228 +== ==