Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Returns information about the version control repository for a Mendix app.

|Name|Type|Required|Description|
|---|---|---|---|
|`AppId`|String|Yes|The App ID of the Mendix app for which the repository information should be returned. You can find this under **Project ID** in the [General](/developerportal/general-settings/) tab of the **Settings** page after you open your app in [Apps](https://sprintr.home.mendix.com/). |
|`AppId`|String|Yes|The App ID of the Mendix app for which the repository information should be returned. You can find this under **Project ID** in the [General](/developerportal/general-settings/) tab of the **Settings** page after you open your app in [Apps](https://sprintr.home.mendix.com/).|

##### Example

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ A JSON object with the following key-value pairs:
| --- | --- | --- |
| 400 | INVALID_PARAMETERS | Not enough parameters given. Please set project_id and environment_id parameters. |
| 400 | NOT_SUPPORTED | This endpoint can only be used with Mendix Cloud |
| 400 | ENVIRONMENT_BUSY | Environment is busy, please try again later or contact Support for assistance.|
| 400 | ENVIRONMENT_BUSY | Environment is busy, please try again later or contact Support for assistance. |
| 400 | INVALID_STATE | Failed to create a backup. There is currently a maintenance action in progress. Please wait until that is finished. |
| 403 | NO_ACCESS | The user does not have access to the backups of this environment. |
| 404 | ENVIRONMENT_NOT_FOUND | Environment not found. |
Expand Down Expand Up @@ -372,7 +372,7 @@ An object with the following key-value pairs:
| 403 | NO_ACCESS | The user does not have access to the backups of this environment. |
| 404 | ENVIRONMENT_NOT_FOUND | Environment not found. |
| 404 | NOT_FOUND | Snapshot not found. |
| 500 | SERVICE_UNAVAILABLE | Operation failed. Please try again later or contact Support if the problem persists.|
| 500 | SERVICE_UNAVAILABLE | Operation failed. Please try again later or contact Support if the problem persists. |

**Example Output**

Expand Down Expand Up @@ -662,7 +662,7 @@ An object with the following key-value pairs:
| 400 | INVALID_STATE | Failed to restore a backup. There is currently a maintenance action in progress. Please wait until that is finished. |
| 400 | ERROR_NOT_ALLOWED | Not allowed to restore backups. |
| 400 | ERROR_NOT_ALLOWED | Restore failed, backup is not in the right state to start restoring. |
| 400 | ERROR_NOT_ALLOWED| Please stop loft before restarting a backup. |
| 400 | ERROR_NOT_ALLOWED | Please stop loft before restarting a backup. |
| 400 | ENVIRONMENT_BUSY | Environment is busy, please try again later or contact Support for assistance. |
| 403 | NO_ACCESS | The user does not have access to the backups of this environment. |
| 404 | ENVIRONMENT_NOT_FOUND | Environment not found. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -943,9 +943,9 @@ Mendix-ApiKey: 26587896-1cef-4483-accf-ad304e2673d6
| HTTP Status | Error code | Description |
| --- | --- | --- |
| 400 | INVALID_REQUEST | You have allocated more memory than is available under your plan. Please contact Support to upgrade your plan. |
| 400 | INVALID_REQUEST | Memory per instance cannot be smaller than 1024 MB.|
| 400 | NOT_ALLOWED| Horizontal scaling (to multiple instances) is only available for apps built with Mendix 7.0 or above. Please upgrade to activate this functionality. |
| 400 | NOT_ALLOWED| Scaling is only available for licensed apps using a supported version of Mendix. |
| 400 | INVALID_REQUEST | Memory per instance cannot be smaller than 1024 MB. |
| 400 | NOT_ALLOWED | Horizontal scaling (to multiple instances) is only available for apps built with Mendix 7.0 or above. Please upgrade to activate this functionality. |
| 400 | NOT_ALLOWED | Scaling is only available for licensed apps using a supported version of Mendix. |
| 404 | ENVIRONMENT_NOT_FOUND | Environment not found. |

##### Example Output
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ Call `setFormatter(undefined)` to reset the formatter to the platform default.
##### Quick Reference

| Formatter type | `type` value | `withConfig` | `getFormatPlaceholder` | Applies to |
|---|---|---|---|---|
| --- | --- | --- | --- | --- |
| `DateTimeFormatter` | `"datetime"` | ✅ `DateTimeFormatterConfig` | ✅ | `Date` |
| `NumberFormatter` | `"number"` | ✅ `NumberFormatterConfig` | ❌ | `Big` (Decimal, Integer, Long) |
| `SimpleFormatter` | `undefined` | ❌ | ❌ | `string`, `boolean`, Enum |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,6 @@ export const component: IComponent = {
};
```


Replace your `src/model/PersonInfo.ts` file with the following:

```typescript {hl_lines=["6-10"]}
Expand Down Expand Up @@ -416,7 +415,6 @@ export const component: IComponent = {
};
```


Return `dependentElementIds` to tell Studio Pro which elements your document depends on. When those elements change, your checks rerun automatically.

{{% alert color="info" %}}
Expand Down Expand Up @@ -487,7 +485,6 @@ async function checkDependencyWasChanged(dependencies: Dependency[], documents:

By checking whether any of the changed documents from the event payload are included in your dependencies, you can trigger the consistency checks to run again by updating the content of your blob document using `studioPro.app.model.customBlobDocuments.updateDocumentContent`. This ensures your checks run again whenever one of your dependencies is modified in Studio Pro.


### Renamed Elements

If one of your dependencies gets renamed, you may need to update the dependency names in your document. Studio Pro cannot automatically rename your dependencies; it can only notify you that the document matching the ID now has a new name. It is up to you to update your dependency's name.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ export const component: IComponent = {
}
};
```

The `permissionsChanged` event fires for all extensions whenever any permission is granted or revoked anywhere in the system, not just for your extension. This means multiple extensions may respond to the same event simultaneously.

To check if a change affects your extension, compare the old granted state against the new one for each permission name your extension declared. Without this check, your extension fires a notification every time any permission changes, including changes unrelated to your extension.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ Call `setFormatter(undefined)` to reset the formatter to the platform default.
##### Quick Reference

| Formatter type | `type` value | `withConfig` | `getFormatPlaceholder` | Applies to |
|---|---|---|---|---|
| --- | --- | --- | --- | --- |
| `DateTimeFormatter` | `"datetime"` | ✅ `DateTimeFormatterConfig` | ✅ | `Date` |
| `NumberFormatter` | `"number"` | ✅ `NumberFormatterConfig` | ❌ | `Big` (Decimal, Integer, Long) |
| `SimpleFormatter` | `undefined` | ❌ | ❌ | `string`, `boolean`, Enum |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -821,15 +821,15 @@ Then the Studio Pro UI for the property appears like this:

The [`action`](#action), [`attribute`](#attribute), [`association`](#association), [`expression`](#expression), [`text template`](#texttemplate), [`widgets`](#widgets), and [`selection`](#selection) properties can be linked to a data source using the `dataSource` attribute on those properties. The client type received by the component depends on the data source type:

| Property type | List data source client type | Object data source client type |
|:---------------|:-----------------------------|:--------------------------------------|
| `action` | [`ListActionValue`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listactionvalue) | [`ActionValue`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#actionvalue) |
| `attribute` | [`ListAttributeValue<T>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listattributevalue) | [`EditableValue<T>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#editable-value) |
| `association` | [`ListReferenceValue` or `ListReferenceSetValue`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listassociationvalue) | `ReferenceValue` or `ReferenceSetValue` |
| `expression` | [`ListExpressionValue<T>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listexpressionvalue) | [`DynamicValue<T>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#dynamic-value) |
| Property type | List data source client type | Object data source client type |
| :--------------- | :----------------------------- | :-------------------------------------- |
| `action` | [`ListActionValue`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listactionvalue) | [`ActionValue`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#actionvalue) |
| `attribute` | [`ListAttributeValue<T>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listattributevalue) | [`EditableValue<T>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#editable-value) |
| `association` | [`ListReferenceValue` or `ListReferenceSetValue`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listassociationvalue) | `ReferenceValue` or `ReferenceSetValue` |
| `expression` | [`ListExpressionValue<T>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listexpressionvalue) | [`DynamicValue<T>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#dynamic-value) |
| `textTemplate` | [`ListExpressionValue<string>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listexpressionvalue) | [`DynamicValue<string>`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis/#dynamic-value) |
| `widgets` | [`ListWidgetValue`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listwidgetvalue) | `ReactNode` |
| `selection` | `SelectionSingleValue` or `SelectionMultiValue` | *Not supported* |
| `widgets` | [`ListWidgetValue`](/apidocs-mxsdk/apidocs/pluggable-widgets-client-apis-list-values/#listwidgetvalue) | `ReactNode` |
| `selection` | `SelectionSingleValue` or `SelectionMultiValue` | *Not supported* |

### Selection {#selection}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -553,12 +553,12 @@ The object property type allows to create an arbitrary list of properties.

#### XML Attributes

| Attribute | Required | Attribute Type | Description |
| Attribute | Required | Attribute Type | Description |
| ---------- | -------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | Yes | String | Must be `object` |
| `key` | Yes | String | See [key](#key) |
| `isList` | Yes | Boolean | Must be `true` |
| `required` | No | Boolean | This decides if the user is required to specify items in the list, `true` by default |
| `type` | Yes | String | Must be `object` |
| `key` | Yes | String | See [key](#key) |
| `isList` | Yes | Boolean | Must be `true` |
| `required` | No | Boolean | This decides if the user is required to specify items in the list, `true` by default |

#### XML Elements

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ Call `setFormatter(undefined)` to reset the formatter to the platform default.
##### Quick Reference

| Formatter type | `type` value | `withConfig` | `getFormatPlaceholder` | Applies to |
|---|---|---|---|---|
| --- | --- | --- | --- | --- |
| `DateTimeFormatter` | `"datetime"` | ✅ `DateTimeFormatterConfig` | ✅ | `Date` |
| `NumberFormatter` | `"number"` | ✅ `NumberFormatterConfig` | ❌ | `Big` (Decimal, Integer, Long) |
| `SimpleFormatter` | `undefined` | ❌ | ❌ | `string`, `boolean`, Enum |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ console.log(`App created with ID: ${app.appId}`);
You can pass the following options to `createNewApp`:

| Name | Description |
|--- | --- |
| --- | --- |
| `repositoryType` | The type of repository to be used. Possible values: `svn` and `git`. |
| `summary` | A short description of the app. |
| `image` | The Base64-encoded data of the app image (height and width between 200px and 400px, with a maximum size of 5 MB). |
Expand Down Expand Up @@ -112,7 +112,7 @@ Working copy creation a resource intensive process, consider reusing previously
You can pass the following options to `createTemporaryWorkingCopy`:

| Name | Description |
|--- | --- |
| --- | --- |
| `commitId` | The ID of the commit on which the working copy should be based. If not passed, the working copy is created from the last commit in the specified branch. |

## Opening the Working Copy Model {#opening-working-copy}
Expand All @@ -135,7 +135,7 @@ await workingCopy.commitToRepository();
You can pass the following options to `commitToRepository`:

| Name | Description |
|--- | --- |
| --- | --- |
| `branchName` | You can specify a branch other than the working copy base branch. In that case, set `force` to `true`. |
| `commitMessage` | Specify a custom commit message instead of the default message ("Imported model changes from online working copy"). |
| `targetCommitId` | This commit ID will be set to the working copy base commit ID if not specified. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The entities can also relate to each other through generalizations. Finally, you

| Studio Pro Guide | Model SDK API Docs |
| --- | --- |
| [Domain Model](/refguide/domain-model/) | TypeScript module [domainmodels](https://apidocs.rnd.mendix.com/modelsdk/latest/modules/domainmodels.html) |
| [Domain Model](/refguide/domain-model/) | TypeScript module [domainmodels](https://apidocs.rnd.mendix.com/modelsdk/latest/modules/domainmodels.html) |
| [Entities](/refguide/entities/) | [DomainModel](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/domainmodels.DomainModel.html) |
| [Attributes](/refguide/attributes/) | [Entity](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/domainmodels.Entity.html) |
| [Associations](/refguide/associations/) | [Association](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/domainmodels.Association.html) |
Expand All @@ -40,7 +40,7 @@ Entities can have multiple attributes. Each attribute has a specific type.

| Studio Pro Guide | Model SDK API docs |
| --- | --- |
| [Attributes](/refguide/attributes/) | Property [`attributes`](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/domainmodels.Entity.html#attributes) of entity |
| [Attributes](/refguide/attributes/) | Property [`attributes`](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/domainmodels.Entity.html#attributes) of entity |
| | [Attribute](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/domainmodels.Attribute.html) |
| | [AttributeType](https://apidocs.rnd.mendix.com/modelsdk/latest/classes/domainmodels.AttributeType.html) |

Expand Down
Loading