### Find Non-Interrupting Notification Event Sub-Process Start Activity by Qualified Name Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/Model.html Retrieves a non-interrupting notification event sub-process start activity using its qualified name. ```APIDOC ## GET /findNonInterruptingNotificationEventSubProcessStartActivityByQualifiedName ### Description Retrieves a non-interrupting notification event sub-process start activity using its qualified name. ### Method GET ### Endpoint /findNonInterruptingNotificationEventSubProcessStartActivityByQualifiedName ### Parameters #### Query Parameters - **qname** (string) - Required - The qualified name of the activity. ### Response #### Success Response (200) - **INonInterruptingNotificationEventSubProcessStartActivity** - The found activity object, or null if not found. #### Response Example ```json { "example": "null | INonInterruptingNotificationEventSubProcessStartActivity" } ``` ``` -------------------------------- ### Constructor: Configuration Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/settings.Configuration.html Details on how to construct a Configuration object. ```APIDOC ## Constructors ### constructor * new Configuration(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit, container: AbstractElement): Configuration * #### Parameters * ##### model: AbstractModel * ##### structureTypeName: string * ##### id: string * ##### isPartial: boolean * ##### unit: ModelUnit * ##### container: AbstractElement #### Returns Configuration ``` -------------------------------- ### getModelEventSource Source: https://apidocs.rnd.mendix.com/modelsdk/latest/interfaces/IModelServerClient.html Gets an EventSource for model events. ```APIDOC ## getModelEventSource ### Description Returns an EventSource instance that will emit events that occur on the working copy model. ### Method GET ### Endpoint /getModelEventSource ### Parameters #### Query Parameters - **workingCopyId** (string) - Required - The ID of the working copy. - **lastFetchedEventId** (number) - Required - The ID of the last fetched event. ### Response #### Success Response (200) - **eventSource** (EventSource) - An EventSource instance for model events. #### Response Example (EventSource object, actual output depends on the EventSource implementation) ``` -------------------------------- ### Static createIn Method Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/settings.ProjectSettings.html Creates a new ProjectSettings unit in the SDK and on the server. ```APIDOC ## Static createIn ### Description Creates a new ProjectSettings unit in the SDK and on the server. Expects one argument, the projects.IProject in which this unit is contained. ### Method ```typescript static createIn(container: IProject): ProjectSettings ``` ### Parameters #### container: IProject * **container** (IProject) - The project in which the ProjectSettings unit will be contained. ### Returns * ProjectSettings ``` -------------------------------- ### Static create Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.Header.html Creates and returns a new Header instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects. ```APIDOC ## Static create ### Description Creates and returns a new Header instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects. ### Method Static ### Endpoint N/A (SDK method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **pages.Header** (Header) - The newly created Header instance. #### Response Example None ``` -------------------------------- ### Accessor: name Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/domainmodels.EnvironmentType.html Gets the name of the EnvironmentType. ```APIDOC ## Accessors ### name * get name(): string * #### Returns string ``` -------------------------------- ### ActionActivity Constructor Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.ActionActivity.html Demonstrates how to create a new instance of ActionActivity. ```APIDOC ## new ActionActivity ### Description Creates a new ActionActivity instance. ### Parameters - **model** (AbstractModel) - The model the activity belongs to. - **structureTypeName** (string) - The type name of the structure. - **id** (string) - The unique identifier for the activity. - **isPartial** (boolean) - Indicates if the activity is partially loaded. - **unit** (ModelUnit) - The unit containing the activity. - **container** (AbstractElement) - The container element of the activity. ### Returns ActionActivity - The newly created ActionActivity instance. ``` -------------------------------- ### Get Properties Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/appservices.MsdDomainModel.html Retrieves properties of the MsdDomainModel. ```APIDOC ## loadedProperties ### Description Returns all properties when this structure is loaded, otherwise just the public properties. ### Method `loadedProperties(): AbstractProperty[]` ### Returns `AbstractProperty[]` - An array of properties. ``` ```APIDOC ## publicProperties ### Description Returns all public properties of the structure. ### Method `publicProperties(): AbstractProperty[]` ### Returns `AbstractProperty[]` - An array of public properties. ``` -------------------------------- ### unit API Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.TextBox.html Provides a method to get the unit. ```APIDOC ## GET unit ### Description Retrieves the unit. ### Method GET ### Endpoint N/A (Property Access) ### Returns ModelUnit ``` -------------------------------- ### ProxyConfiguration.create() Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.ProxyConfiguration.html Creates a new ProxyConfiguration instance and returns it. This instance is added to the SDK and the server. It requires an IModel object as an argument, which determines the context for the instance. After creation, you must assign or add this instance to a suitable property. ```APIDOC ## POST /api/proxyconfiguration ### Description Creates a new ProxyConfiguration instance within the provided IModel context. ### Method POST ### Endpoint /api/proxyconfiguration ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **model** (IModel) - Required - The IModel object to associate the new ProxyConfiguration with. ### Request Example ```json { "model": "" } ``` ### Response #### Success Response (200) - **proxyConfiguration** (ProxyConfiguration) - The newly created ProxyConfiguration object. #### Response Example ```json { "proxyConfiguration": { "id": "", "name": "NewProxyConfiguration" } } ``` ``` -------------------------------- ### Height Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.StaticImageViewer.html Allows getting and setting the height of an element. ```APIDOC ## Height ### Description Provides methods to get and set the height of an element. ### Methods - `get height(): number` - Retrieves the current height. - `set height(newValue: number): void` - Sets a new height value. ### Parameters - `newValue` (number) - The new height value to set. ``` -------------------------------- ### StartEvent Static Creation Methods Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.StartEvent.html Methods for creating new StartEvent instances. ```APIDOC ## Static create ### Description Creates and returns a new StartEvent instance in the SDK and on the server. Expects one argument: the IModel object the instance will 'live on'. After creation, assign or add this instance to a property that accepts this kind of objects. ### Method `create(model: IModel): StartEvent` ### Parameters - **model** (IModel) - Required - The IModel object the instance will belong to. ### Returns `StartEvent` - A new StartEvent instance. ## Static createIn ### Description Creates and returns a new StartEvent instance in the SDK and on the server. The new StartEvent will be automatically stored in the 'objects' property of the parent MicroflowObjectCollection element passed as argument. ### Method `createIn(container: MicroflowObjectCollection): StartEvent` ### Parameters - **container** (MicroflowObjectCollection) - Required - The container element for the new StartEvent. ### Returns `StartEvent` - A new StartEvent instance. ``` -------------------------------- ### Icon Properties Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.SidebarToggleButton.html Get and set the icon of an element. ```APIDOC ## GET /icon ### Description Retrieves the icon associated with an element. ### Method GET ### Endpoint /icon ### Returns null | Icon Returns the Icon object or null if no icon is set. ## SET /icon ### Description Sets the icon for an element. ### Method SET ### Endpoint /icon ### Parameters #### Request Body - **newValue** (null | Icon) - Required - The Icon object to set, or null to remove the icon. ### Returns void ``` -------------------------------- ### EntityKeyPart Static Creation Methods Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/domainmodels.EntityKeyPart.html Documentation for static methods used to create new EntityKeyPart instances. ```APIDOC ## POST /entitykeypart/create ### Description Creates and returns a new EntityKeyPart instance in the SDK and on the server. Assign or add this instance to a property that accepts this kind of objects. ### Method POST ### Endpoint /entitykeypart/create ### Parameters #### Request Body - **model** (IModel) - Required - The IModel object the instance will live on. ### Returns - **EntityKeyPart** - The newly created EntityKeyPart instance. ``` ```APIDOC ## POST /entitykeypart/createIn ### Description Creates and returns a new EntityKeyPart instance in the SDK and on the server. The new EntityKeyPart will be automatically stored in the 'parts' property of the parent EntityKey element. Warning! Can only be used on models with the following Mendix meta model versions: 8.9.0 and higher ### Method POST ### Endpoint /entitykeypart/createIn ### Parameters #### Request Body - **container** (EntityKey) - Required - The parent EntityKey element. ### Returns - **EntityKeyPart** - The newly created EntityKeyPart instance. ``` -------------------------------- ### Model Property Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.Grid.html Gets the model associated with the element. ```APIDOC ## GET /model ### Description Gets the model associated with this element. ### Method GET ### Endpoint /model ### Response #### Success Response (200) - **TModel** (TModel) - The associated model. ``` -------------------------------- ### Static create Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/settings.JarDeploymentSettings.html Creates a new JarDeploymentSettings instance associated with the given IModel. ```APIDOC ## Static create ### Description Creates and returns a new JarDeploymentSettings instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects. ### Method POST ### Endpoint `/create` ### Parameters #### Request Body - **model** (IModel) - Required - The IModel object the instance will be associated with. ### Returns - `JarDeploymentSettings` - The newly created JarDeploymentSettings instance. ``` -------------------------------- ### Model Property Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.DatePicker.html Gets the model associated with the widget. ```APIDOC ## GET model ### Description Gets the model associated with the widget. ### Method GET ### Endpoint model ### Returns TModel ``` -------------------------------- ### JarDeploymentSettings Constructor Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/settings.JarDeploymentSettings.html Initializes a new instance of the JarDeploymentSettings class. ```APIDOC ## new JarDeploymentSettings(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit, container: AbstractElement): JarDeploymentSettings ### Description Initializes a new instance of the JarDeploymentSettings class. ### Parameters - **model** (AbstractModel) - The model instance. - **structureTypeName** (string) - The type name of the structure. - **id** (string) - The unique identifier for the settings. - **isPartial** (boolean) - Indicates if the settings are partial. - **unit** (ModelUnit) - The model unit containing these settings. - **container** (AbstractElement) - The container element for these settings. ### Returns JarDeploymentSettings - The newly created JarDeploymentSettings instance. ``` -------------------------------- ### Static create Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/queues.BasicQueueConfig.html Creates a new BasicQueueConfig instance. ```APIDOC ## Static create ### Description Creates and returns a new BasicQueueConfig instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects. ### Method POST (or similar, depending on context) ### Endpoint Not applicable (static method) ### Parameters #### Request Body - **model** (IModel) - Required - The IModel object the instance will be associated with. ### Request Example ```javascript const newConfig = BasicQueueConfig.create(currentModel); ``` ### Response #### Success Response (200) - **basicQueueConfig** (BasicQueueConfig) - The newly created BasicQueueConfig instance. ### Response Example ```json { "basicQueueConfig": { ... } } ``` ``` -------------------------------- ### Model Property Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.DropDownButton.html Gets the model associated with the widget. ```APIDOC ## GET /websites/apidocs_rnd_mendix_modelsdk/model ### Description Gets the Mendix model associated with this widget. ### Method GET ### Endpoint /websites/apidocs_rnd_mendix_modelsdk/model ### Returns TModel - **TModel** (TModel) - The associated Mendix model. ``` -------------------------------- ### DistributionSettings Static Creation Methods Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/settings.DistributionSettings.html Static methods for creating new instances of DistributionSettings. ```APIDOC ## Static create ### Description Creates and returns a new DistributionSettings instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects. ### Method `create(model: IModel): DistributionSettings` ### Parameters ##### model: IModel * Type: `IModel` * Description: The model object the instance will be associated with. ### Returns `DistributionSettings` ## Static createIn ### Description Creates and returns a new DistributionSettings instance in the SDK and on the server. The new DistributionSettings will be automatically stored in the 'settingsParts' property of the parent ProjectSettings element passed as argument. Warning! Can only be used on models with the following Mendix meta model versions: 9.24.0 and higher ### Method `createIn(container: ProjectSettings): DistributionSettings` ### Parameters ##### container: ProjectSettings * Type: `ProjectSettings` * Description: The container element (ProjectSettings) in which to create the new DistributionSettings. ### Returns `DistributionSettings` ``` -------------------------------- ### Accessor: name Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/domainmodels.MemberAccessRights.html Gets the name of the MemberAccessRights instance. ```APIDOC ## Accessor: name ### get name(): string #### Returns string ``` -------------------------------- ### NativeHomePage Static Creation Methods Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/navigation.NativeHomePage.html Documentation for static methods used to create new NativeHomePage instances. ```APIDOC ## Static create ### Description Creates and returns a new NativeHomePage instance in the SDK and on the server. Assign or add this instance to a property that accepts such objects. ### Method `create(model: IModel): NativeHomePage` ### Endpoint N/A (Static Method) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) - **NativeHomePage** - A new instance of NativeHomePage. #### Response Example N/A ``` ```APIDOC ## Static createIn ### Description Creates and returns a new NativeHomePage instance in the SDK and on the server. The new instance is automatically stored in the 'nativeHomePage' property of the parent NativeNavigationProfile element. ### Method `createIn(container: NativeNavigationProfile): NativeHomePage` ### Endpoint N/A (Static Method) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (200) - **NativeHomePage** - A new instance of NativeHomePage. #### Response Example N/A ### Note Can only be used on models with Mendix meta model versions: 9.4.0 and higher. ``` -------------------------------- ### getWorkingCopyEventSource Source: https://apidocs.rnd.mendix.com/modelsdk/latest/interfaces/IModelServerClient.html Gets an EventSource for working copy level events. ```APIDOC ## getWorkingCopyEventSource ### Description Returns an EventSource instance that will emit events that occur on the working copy level. ### Method GET ### Endpoint /getWorkingCopyEventSource ### Parameters #### Query Parameters - **workingCopyId** (string) - Required - The ID of the working copy. ### Response #### Success Response (200) - **eventSource** (EventSource) - An EventSource instance for working copy events. #### Response Example (EventSource object, actual output depends on the EventSource implementation) ``` -------------------------------- ### Static create Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/microflows.BasicAuthConfig.html Creates a new BasicAuthConfig instance. ```APIDOC ## Static create ### Description Creates and returns a new BasicAuthConfig instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects. ### Method POST (or similar, inferred from context for creation) ### Endpoint (Inferred, typically a static endpoint for the class) ### Parameters #### Request Body - **model** (IModel) - Required - The IModel object the instance will be associated with. ### Request Example ```javascript const newAuthConfig = BasicAuthConfig.create(currentModel); ``` ### Response #### Success Response (200) - **basicAuthConfig** (BasicAuthConfig) - The newly created BasicAuthConfig instance. ### Response Example ```json { "id": "generated-id", "name": "NewAuthConfig" } ``` ``` -------------------------------- ### Get Public Properties Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/webservices.ServiceInfo.html Retrieves only the public properties of a structure. ```APIDOC ## GET /api/structures/{id}/publicProperties ### Description Returns only the public properties of this structure. ### Method GET ### Endpoint /api/structures/{id}/publicProperties ### Parameters #### Path Parameters * **id** (string) - Required - The unique identifier of the structure. #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) * **AbstractProperty[]** (AbstractProperty[]) - An array of AbstractProperty objects representing public properties. #### Response Example ```json { "properties": [ "", "" ] } ``` ``` -------------------------------- ### DemoUser Constructor Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/security.DemoUser.html Demonstrates how to instantiate a new DemoUser object. ```APIDOC ## new DemoUser() ### Description Instantiates a new DemoUser object. ### Parameters - **model** (AbstractModel) - The model instance. - **structureTypeName** (string) - The type name of the structure. - **id** (string) - The unique identifier for the demo user. - **isPartial** (boolean) - Indicates if the object is partially loaded. - **unit** (ModelUnit) - The model unit containing this demo user. - **container** (AbstractElement) - The container element for this demo user. ### Returns DemoUser - The newly created DemoUser instance. ``` -------------------------------- ### Get WsdlDescription Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/webservices.WsdlDescription.html Retrieves the WSDL description for a given container. ```APIDOC ## GET /websites/apidocs_rnd_mendix_modelsdk ### Description Retrieves the WSDL description for a given container. ### Method GET ### Endpoint /websites/apidocs_rnd_mendix_modelsdk ### Parameters #### Query Parameters - **container** (Msd) - Required - The container for which to retrieve the WSDL description. ``` -------------------------------- ### Button Constructor Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.Button.html Details on how to instantiate a Button object. ```APIDOC ## Constructors ### constructor * new Button(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit, container: AbstractElement): Button * #### Parameters * ##### model: AbstractModel * ##### structureTypeName: string * ##### id: string * ##### isPartial: boolean * ##### unit: ModelUnit * ##### container: AbstractElement #### Returns Button ``` -------------------------------- ### validation API Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.TextBox.html Provides methods to get and set the validation. ```APIDOC ## GET validation ### Description Retrieves the validation settings. ### Method GET ### Endpoint N/A (Property Access) ### Returns WidgetValidation --- ## SET validation ### Description Sets the validation settings. ### Method SET ### Endpoint N/A (Property Access) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters #### newValue - **newValue** (WidgetValidation) - Required - The new widget validation settings to set. ### Returns void ``` -------------------------------- ### tabIndex API Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.TextBox.html Provides methods to get and set the tabIndex. ```APIDOC ## GET tabIndex ### Description Retrieves the tabIndex. ### Method GET ### Endpoint N/A (Property Access) ### Returns number --- ## SET tabIndex ### Description Sets the tabIndex. ### Method SET ### Endpoint N/A (Property Access) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters #### newValue - **newValue** (number) - Required - The new tab index value to set. ### Returns void ``` -------------------------------- ### Style Constructor Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/documenttemplates.Style.html Details on how to instantiate a new Style object. ```APIDOC ## Constructors ### constructor * new Style(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, unit: ModelUnit, container: AbstractElement): Style * #### Parameters * ##### model: AbstractModel * ##### structureTypeName: string * ##### id: string * ##### isPartial: boolean * ##### unit: ModelUnit * ##### container: AbstractElement #### Returns Style ``` -------------------------------- ### submitOnInputDelay API Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.TextBox.html Provides methods to get and set the submitOnInputDelay. ```APIDOC ## GET submitOnInputDelay ### Description Retrieves the submitOnInputDelay. ### Method GET ### Endpoint N/A (Property Access) ### Returns number --- ## SET submitOnInputDelay ### Description Sets the submitOnInputDelay. ### Method SET ### Endpoint N/A (Property Access) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters #### newValue - **newValue** (number) - Required - The new delay in milliseconds to set for submitting on input. ### Returns void ``` -------------------------------- ### WebUIProjectSettingsPart Static Creation Methods Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/settings.WebUIProjectSettingsPart.html Details on how to create new instances of WebUIProjectSettingsPart using static factory methods. ```APIDOC ## Static create(model: IModel) ### Description Creates and returns a new WebUIProjectSettingsPart instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects. ### Method POST ### Endpoint N/A (Static method) ### Parameters #### Request Body - **model** (IModel) - Required - The IModel object the instance will be associated with. ### Returns WebUIProjectSettingsPart - A new instance of WebUIProjectSettingsPart. ## Static createIn(container: ProjectSettings) ### Description Creates and returns a new WebUIProjectSettingsPart instance in the SDK and on the server. The new WebUIProjectSettingsPart will be automatically stored in the 'settingsParts' property of the parent ProjectSettings element passed as argument. ### Method POST ### Endpoint N/A (Static method) ### Parameters #### Request Body - **container** (ProjectSettings) - Required - The parent ProjectSettings element. ### Returns WebUIProjectSettingsPart - A new instance of WebUIProjectSettingsPart. ``` -------------------------------- ### Static create Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/documenttemplates.Table.html Creates a new Table instance. ```APIDOC ## Static create ### Description Creates and returns a new Table instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects. ### Method POST (assumed, as it's a creation operation) ### Endpoint `/websites/apidocs_rnd_mendix_modelsdk/create` (example endpoint) ### Parameters #### Request Body - **model** (IModel) - Required - The IModel object the instance will live on. ### Response #### Success Response (200) - **documenttemplates.Table** - The newly created Table instance. #### Response Example ```json { "newTable": { "id": "generated-table-id", "rows": [] } } ``` ``` -------------------------------- ### submitBehaviour API Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.TextBox.html Provides methods to get and set the submitBehaviour. ```APIDOC ## GET submitBehaviour ### Description Retrieves the submitBehaviour. ### Method GET ### Endpoint N/A (Property Access) ### Returns SubmitBehaviourType --- ## SET submitBehaviour ### Description Sets the submitBehaviour. ### Method SET ### Endpoint N/A (Property Access) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters #### newValue - **newValue** (SubmitBehaviourType) - Required - The new submit behaviour type to set. ### Returns void ``` -------------------------------- ### sourceVariable API Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.TextBox.html Provides methods to get and set the sourceVariable. ```APIDOC ## GET sourceVariable ### Description Retrieves the sourceVariable. ### Method GET ### Endpoint N/A (Property Access) ### Returns null | PageVariable --- ## SET sourceVariable ### Description Sets the sourceVariable. ### Method SET ### Endpoint N/A (Property Access) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters #### newValue - **newValue** (null | PageVariable) - Required - The new page variable or null to set as the source variable. ### Returns void ``` -------------------------------- ### Folder Constructor Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/projects.Folder.html Details on how to instantiate a new Folder object. ```APIDOC ## Constructors ### constructor * new Folder(model: AbstractModel, structureTypeName: string, id: string, isPartial: boolean, container: IFolderBase): Folder * #### Parameters * ##### model: AbstractModel * ##### structureTypeName: string * ##### id: string * ##### isPartial: boolean * ##### container: IFolderBase #### Returns Folder ``` -------------------------------- ### screenReaderLabel API Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.TextBox.html Provides methods to get and set the screenReaderLabel. ```APIDOC ## GET screenReaderLabel ### Description Retrieves the screenReaderLabel. ### Method GET ### Endpoint N/A (Property Access) ### Returns null | ClientTemplate --- ## SET screenReaderLabel ### Description Sets the screenReaderLabel. ### Method SET ### Endpoint N/A (Property Access) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters #### newValue - **newValue** (null | ClientTemplate) - Required - The new client template or null to set for the screen reader label. ### Returns void ``` -------------------------------- ### Create Folder In Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/projects.Folder.html Creates a new Folder unit in the SDK and on the server. ```APIDOC ## Static createIn ### Description Creates a new Folder unit in the SDK and on the server. Expects one argument, the IFolderBase in which this unit is contained. ### Method Static method ### Endpoint N/A (Static method call) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "container": "IFolderBase" } ``` ### Response #### Success Response (Folder) Returns a newly created Folder object. #### Response Example ```json { "type": "Folder" } ``` ``` -------------------------------- ### Static Creation Methods for QueueSettings Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/queues.QueueSettings.html Static methods for creating new QueueSettings instances. ```APIDOC ## POST /create ### Description Creates and returns a new QueueSettings instance in the SDK and on the server. ### Method POST ### Endpoint /create ### Parameters #### Request Body - **model** (IModel) - Required - The IModel object the instance will live on. ### Returns QueueSettings - A new QueueSettings instance. ``` ```APIDOC ## POST /createInJavaActionCallActionUnderQueueSettings ### Description Creates a new QueueSettings instance and automatically stores it in the 'queueSettings' property of the provided JavaActionCallAction. ### Method POST ### Endpoint /createInJavaActionCallActionUnderQueueSettings ### Parameters #### Request Body - **container** (JavaActionCallAction) - Required - The parent JavaActionCallAction element. ### Returns QueueSettings - A new QueueSettings instance. ### Warning Requires Mendix meta model version 9.10.0 or higher. ``` ```APIDOC ## POST /createInMicroflowCallUnderQueueSettings ### Description Creates a new QueueSettings instance and automatically stores it in the 'queueSettings' property of the provided MicroflowCall. ### Method POST ### Endpoint /createInMicroflowCallUnderQueueSettings ### Parameters #### Request Body - **container** (MicroflowCall) - Required - The parent MicroflowCall element. ### Returns QueueSettings - A new QueueSettings instance. ### Warning Requires Mendix meta model version 9.10.0 or higher. ``` -------------------------------- ### readOnlyStyle API Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.TextBox.html Provides methods to get and set the readOnlyStyle. ```APIDOC ## GET readOnlyStyle ### Description Retrieves the readOnlyStyle. ### Method GET ### Endpoint N/A (Property Access) ### Returns ReadOnlyStyle --- ## SET readOnlyStyle ### Description Sets the readOnlyStyle. ### Method SET ### Endpoint N/A (Property Access) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters #### newValue - **newValue** (ReadOnlyStyle) - Required - The new read-only style to set. ### Returns void ``` -------------------------------- ### CertificateSettings - Static create Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/settings.CertificateSettings.html Creates a new CertificateSettings instance within the SDK and on the server. ```APIDOC ## Static create ### Description Creates and returns a new CertificateSettings instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects. ### Method `create(model: IModel): CertificateSettings` ### Parameters - **model** (IModel) - Required - The IModel object the instance will be associated with. ### Returns - `CertificateSettings` - The newly created CertificateSettings instance. ``` -------------------------------- ### placeholderTemplate API Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.TextBox.html Provides methods to get and set the placeholderTemplate. ```APIDOC ## GET placeholderTemplate ### Description Retrieves the placeholderTemplate. ### Method GET ### Endpoint N/A (Property Access) ### Returns ClientTemplate --- ## SET placeholderTemplate ### Description Sets the placeholderTemplate. ### Method SET ### Endpoint N/A (Property Access) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Parameters #### newValue - **newValue** (ClientTemplate) - Required - The new client template to set as placeholder. ### Returns void ``` -------------------------------- ### Mode Properties Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.SidebarToggleButton.html Get and set the mode for sidebar toggle. ```APIDOC ## GET /mode ### Description Retrieves the current mode for sidebar toggle. ### Method GET ### Endpoint /mode ### Returns SidebarToggleMode Returns the SidebarToggleMode. ## SET /mode ### Description Sets the mode for sidebar toggle. Note: This property was deleted in version 6.10.0. ### Method SET ### Endpoint /mode ### Parameters #### Request Body - **newValue** (SidebarToggleMode) - Required - The new SidebarToggleMode to set. ### Returns void ``` -------------------------------- ### Static Creation Method Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/projects.ModuleSettings.html Method for creating new ModuleSettings units. ```APIDOC ## POST /createIn ### Description Creates a new ModuleSettings unit within the SDK and on the server. Requires the container (IModule) in which this unit will be contained. ### Method POST ### Endpoint /createIn ### Parameters #### Request Body - **container** (IModule) - Required - The IModule in which the new ModuleSettings unit will be created. ### Response #### Success Response (200) - **moduleSettings** (ModuleSettings) - The newly created ModuleSettings unit. #### Response Example ```json { "moduleSettings": { "id": "new-module-settings-id", "name": "NewModuleSettings" } } ``` ``` -------------------------------- ### ButtonStyle Properties Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.SidebarToggleButton.html Get and set the button style of an element. ```APIDOC ## GET /buttonStyle ### Description Retrieves the button style settings for an element. ### Method GET ### Endpoint /buttonStyle ### Returns ButtonStyle Returns the ButtonStyle object. ## SET /buttonStyle ### Description Sets the button style settings for an element. ### Method SET ### Endpoint /buttonStyle ### Parameters #### Request Body - **newValue** (ButtonStyle) - Required - The new ButtonStyle object to set. ### Returns void ``` -------------------------------- ### Static create Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/documenttemplates.Header.html Creates a new Header instance in the SDK and on the server. ```APIDOC ## Static create ### Description Creates and returns a new Header instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects. ### Method POST (assumed, as it creates a new resource) ### Endpoint Not applicable (static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **model** (IModel) - The IModel object the instance will live on. ### Request Example ```javascript const newHeader = documenttemplates.Header.create(model); ``` ### Response #### Success Response (200) - **header** (documenttemplates.Header) - The newly created Header instance. #### Response Example ```json { "header": { ... } // The created header object } ``` ``` -------------------------------- ### TabIndex Properties Source: https://apidocs.rnd.mendix.com/modelsdk/latest/classes/pages.NavigationList.html Get and set the tab index of an element. ```APIDOC ## GET /tabIndex ### Description Retrieves the tab index of the element. ### Method GET ### Endpoint /tabIndex ### Returns - **tabIndex** (number) - The tab index of the element. ### Response Example { "example": "0" } ## SET /tabIndex ### Description Sets the tab index of the element. ### Method SET ### Endpoint /tabIndex ### Parameters #### Request Body - **newValue** (number) - Required - The new tab index to set. ### Request Example { "example": "1" } ### Response #### Success Response (200) - **void** - Indicates the operation was successful. ### Response Example { "example": "null" } ```