Skip to content

Commit 9a2c281

Browse files
kizaonlinekizaonline
authored
Merge pull request #58 from blinkmobile/ON-4597
ON-4597 # Added formsAppEnvironmentId to docs
2 parents 4775a30 + 4695920 commit 9a2c281

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

‎docs/forms-apps.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ const formsApp = {
4545
splashScreenName: 'Application'
4646
},
4747
organisationId: 'ABCDEFGHIJKL123456789012',
48+
formsAppEnvironmentId: 1,
4849
formIds: []
4950
}
5051
formsAppsSDK.createFormsApp(formsApp).then(savedFormsApp => {
@@ -60,6 +61,7 @@ formsAppsSDK.createFormsApp(formsApp).then(savedFormsApp => {
6061
| `formsApp.name` | Yes | `string` | Name of the forms app |
6162
| `formsApp.hostname` | Yes | `string` | Hostname (domain) for the forms app |
6263
| `formsApp.organisationId` | Yes | `string` | The exact organisation identifier the forms app is associated with |
64+
| `formsApp.formsAppEnvironmentId` | Yes | `number` | The exact forms app environment identifier the forms app is associated with |
6365
| `formsApp.formIds` | Yes | `number[]` | The identifiers of the forms that are in the forms app. The order of the forms is respected when rendering the list of forms |
6466
| `formsApp.pwaSettings` | Yes | `Object` | Forms App progressive web app setting properties |
6567
| `formsApp.pwaSettings.homeScreenName` | No | `string` | The text beneath the app icon when installed as a progressive web app on mobile devices |
@@ -85,6 +87,7 @@ formsAppsSDK.createFormsApp(formsApp).then(savedFormsApp => {
8587
"createdAt": "2018-06-01T00:00:00.000Z",
8688
"updatedAt": "2019-05-17T05:49:14.000Z",
8789
"organisationId": "ABCDEFGHIJKL123456789012",
90+
"formsAppEnvironmentId": 1,
8891
"formIds": []
8992
}
9093
```
@@ -236,6 +239,7 @@ formsAppsSDK.getFormsApp(formsAppId).then(formsApp => {
236239
"createdAt": "2018-06-01T00:00:00.000Z",
237240
"updatedAt": "2019-05-17T05:49:14.000Z",
238241
"organisationId": "ABCDEFGHIJKL123456789012",
242+
"formsAppEnvironmentId": 1,
239243
"formIds": []
240244
}
241245
```
@@ -282,6 +286,7 @@ const formsApp = {
282286
createdAt: '2018-06-01T00:00:00.000Z',
283287
updatedAt: '2019-05-17T05:49:14.000Z',
284288
organisationId: 'ABCDEFGHIJKL123456789012',
289+
formsAppEnvironmentId: 1,
285290
formIds: []
286291
}
287292
formsAppsSDK.updateFormsApp(formsApp).then(savedFormsApp => {
@@ -298,6 +303,7 @@ formsAppsSDK.updateFormsApp(formsApp).then(savedFormsApp => {
298303
| `formsApp.name` | Yes | `string` | Name of the forms app |
299304
| `formsApp.hostname` | Yes | `string` | Hostname (domain) for the forms app |
300305
| `formsApp.organisationId` | Yes | `string` | The exact organisation identifier the forms app is associated with |
306+
| `formsApp.formsAppEnvironmentId` | Yes | `number` | The exact forms app environment identifier the forms app is associated with |
301307
| `formsApp.oAuthClientId` | Yes | `string` | The identifier of the OAuth Client for the forms app **(Do not change this)**. |
302308
| `formsApp.formIds` | Yes | `number[]` | The identifiers of the forms that are in the forms app. The order of the forms is respected when rendering the list of forms |
303309
| `formsApp.pwaSettings` | Yes | `Object` | Forms App progressive web app setting properties |
@@ -324,6 +330,7 @@ formsAppsSDK.updateFormsApp(formsApp).then(savedFormsApp => {
324330
"createdAt": "2018-06-01T00:00:00.000Z",
325331
"updatedAt": "2019-05-17T05:49:14.000Z",
326332
"organisationId": "ABCDEFGHIJKL123456789012",
333+
"formsAppEnvironmentId": 1,
327334
"formIds": []
328335
}
329336
```

‎docs/forms.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,7 @@ forms.getForm(formId, injectForms).then(form => {
229229
"formsAppEnvironmentId": 1,
230230
"description": "a form",
231231
"organisationId": "0101010101010",
232+
"formsAppEnvironmentId": 1,
232233
"elements": [],
233234
"isAuthenticated": false,
234235
"isPublished": true,
@@ -281,6 +282,7 @@ forms
281282
"formsAppEnvironmentId": 1,
282283
"description": "a form",
283284
"organisationId": "0101010101010",
285+
"formsAppEnvironmentId": 1,
284286
"elements": [],
285287
"isAuthenticated": false,
286288
"isPublished": true,
@@ -305,6 +307,7 @@ const form = {
305307
formsAppEnvironmentId: 1,
306308
description: 'a form',
307309
organisationId: '0101010101010',
310+
formsAppEnvironmentId: 1,
308311
elements: [],
309312
isAuthenticated: false,
310313
isPublished: true,
@@ -325,6 +328,7 @@ return validatedForm
325328
| `name` | yes | `string` | Name of the form. |
326329
| `description` | No | `string` | A description of the form. |
327330
| `organisationId` | yes | `string` | The organisation ID the form belong to. |
331+
| `formsAppEnvironmentId` | yes | `number` | The forms app environment ID the form belong to. |
328332
| `formsAppIds` | yes | `number[]` | ID's of any Forms Apps that the form is included in. |
329333
| `elements` | yes | [`FormElement`](./form-elements/README.md)`[]` | All elements contained within the form itself. |
330334
| `isAuthenticated` | yes | `boolean` | Whether or not the form can only be viewed by an Authenticated user. |
@@ -346,7 +350,7 @@ return validatedForm
346350
| `postSubmissionAction` | Yes | `string` | The action for the Form to take on a successful submission. |
347351
| `redirectUrl` | No | `string` | The URL the form will redirect to if configured to do so by the `postSubmissionActions`. |
348352
| `isInfoPage` | Yes | `boolean` | Whether or not the Form is an Info Page. |
349-
| `formsAppEnvironmentId` | Yes | `number` | the environment the form has been placed in |
353+
| `formsAppEnvironmentId` | Yes | `number` | the environment the form has been placed in |
350354

351355
### Result
352356

@@ -356,6 +360,7 @@ return validatedForm
356360
"name": "testsform",
357361
"description": "a form",
358362
"organisationId": "0101010101010",
363+
"formsAppEnvironmentId": 1,
359364
"elements": [],
360365
"isAuthenticated": false,
361366
"isPublished": true,

0 commit comments

Comments
 (0)