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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion docs/configurator/libraries/methods/configuration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export default [
},
{
"methodName": "updateRequirement",
"description": "Updates a requirement on the this configuration. This can be used to (de)select a feature or set a value on a feature.",
"description": "Updates a requirement on this configuration. This can be used to (de)select a feature or set a value on a feature.",
"example": {
"content": "const nodeId = '00000000-0000-0000-0000-000000000000';\nconst value = 1;\nconst isSelection = true;\n\nawait configuration.updateRequirement(nodeId, isSelection, value);\n",
"language": "typescript"
Expand Down Expand Up @@ -96,6 +96,13 @@ export default [
"description": "The text value to set on the feature",
"required": true,
"parameters": []
},
{
"name": "configurationId",
"type": "string",
"description": "Optional id of the linked configuration that owns the node, when it lives in a linked model rather than this one. Must be within this configuration's linked-configuration subtree; the backend validates it and falls back to resolving the owner itself when omitted or invalid.",
"required": false,
"parameters": []
}
],
"deprecated": null,
Expand Down Expand Up @@ -125,6 +132,13 @@ export default [
"description": "The image value to set on the feature",
"required": true,
"parameters": []
},
{
"name": "configurationId",
"type": "string",
"description": "Optional id of the linked configuration that owns the node, when it lives in a linked model rather than this one. Must be within this configuration's linked-configuration subtree; the backend validates it and falls back to resolving the owner itself when omitted or invalid.",
"required": false,
"parameters": []
}
],
"deprecated": null,
Expand Down
17 changes: 7 additions & 10 deletions docs/configurator/libraries/methods/configuratorContext.ts
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
export default [
{
"methodName": "constructor",
"description": "Initializes a new instance with the provided options.",
"example": {
"content": "import { ConfiguratorContext, AuthenticationMethod } from '@elfsquad/configurator';\n\nconst context = new ConfiguratorContext({\n authenticationMethod: AuthenticationMethod.ANONYMOUS,\n tenantId: 'your-tenant-id',\n});\n",
"language": "typescript"
},
"description": "",
"example": null,
"parameters": [
{
"name": "_options",
"type": "IConfiguratorOptions",
"description": "The options that are used to configure the context.",
"description": "",
"required": true,
"parameters": [
{
Expand Down Expand Up @@ -99,7 +96,7 @@ export default [
"name": "language",
"type": "string",
"description": "The language to start the configuration in.",
"required": true,
"required": false,
"parameters": []
},
{
Expand Down Expand Up @@ -164,7 +161,7 @@ export default [
"name": "language",
"type": "string",
"description": "The language is used for retrieving localized texts.",
"required": true,
"required": false,
"parameters": []
}
],
Expand Down Expand Up @@ -517,7 +514,7 @@ export default [
"name": "configurationIds",
"type": "string[]",
"description": "The configuration ids. If not provided, the root configuration id will be used.",
"required": true,
"required": false,
"parameters": []
}
],
Expand Down Expand Up @@ -560,7 +557,7 @@ export default [
},
{
"name": "object",
"type": "any",
"type": "unknown",
"description": "",
"required": true,
"parameters": []
Expand Down