Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/app_router.InvalidRequestSignatureError.html b/classes/app_router.InvalidRequestSignatureError.html index 1a59d25f..0abdeb5a 100644 --- a/classes/app_router.InvalidRequestSignatureError.html +++ b/classes/app_router.InvalidRequestSignatureError.html @@ -1,6 +1,6 @@RequestSignature is invalid for given appSecret.
-Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/business_objects.BusinessObjectsError.html b/classes/business_objects.BusinessObjectsError.html index 410c8148..7454783a 100644 --- a/classes/business_objects.BusinessObjectsError.html +++ b/classes/business_objects.BusinessObjectsError.html @@ -1,6 +1,6 @@Generic Error for business-objects package.
-Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/core.BadInputError.html b/classes/core.BadInputError.html index ff013c6a..37917d33 100644 --- a/classes/core.BadInputError.html +++ b/classes/core.BadInputError.html @@ -1,4 +1,4 @@ -Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/core.DeepMergeError.html b/classes/core.DeepMergeError.html index ffd5be92..cb355f29 100644 --- a/classes/core.DeepMergeError.html +++ b/classes/core.DeepMergeError.html @@ -1,4 +1,4 @@ -Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/core.DvelopSdkError.html b/classes/core.DvelopSdkError.html index de15f904..6e69cf0a 100644 --- a/classes/core.DvelopSdkError.html +++ b/classes/core.DvelopSdkError.html @@ -1,4 +1,4 @@ -Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/core.ForbiddenError.html b/classes/core.ForbiddenError.html index 458f5477..3130b497 100644 --- a/classes/core.ForbiddenError.html +++ b/classes/core.ForbiddenError.html @@ -1,4 +1,4 @@ -Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/core.NotFoundError.html b/classes/core.NotFoundError.html index 3398d04d..73a4c2d3 100644 --- a/classes/core.NotFoundError.html +++ b/classes/core.NotFoundError.html @@ -1,4 +1,4 @@ -Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/core.TraceContextError.html b/classes/core.TraceContextError.html index f9fae805..82b985ee 100644 --- a/classes/core.TraceContextError.html +++ b/classes/core.TraceContextError.html @@ -1,6 +1,6 @@Indicates an error with the TraceContext.
-Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/core.UnauthorizedError.html b/classes/core.UnauthorizedError.html index 45fe3d4b..3d7ec443 100644 --- a/classes/core.UnauthorizedError.html +++ b/classes/core.UnauthorizedError.html @@ -1,4 +1,4 @@ -Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/dms.DmsError.html b/classes/dms.DmsError.html index 23bcb545..21e80a06 100644 --- a/classes/dms.DmsError.html +++ b/classes/dms.DmsError.html @@ -1,6 +1,6 @@Generic Error for dms-package.
-Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/dms.ReleaseAndUpdateDmsObjectError.html b/classes/dms.ReleaseAndUpdateDmsObjectError.html index 8f23e279..f609c8a0 100644 --- a/classes/dms.ReleaseAndUpdateDmsObjectError.html +++ b/classes/dms.ReleaseAndUpdateDmsObjectError.html @@ -1,6 +1,6 @@This error indicates a problem with reading the DmsObject. Do you have all relevant permissions?
-Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/identityprovider.IdentityproviderError.html b/classes/identityprovider.IdentityproviderError.html index 5f342cff..34131568 100644 --- a/classes/identityprovider.IdentityproviderError.html +++ b/classes/identityprovider.IdentityproviderError.html @@ -1,6 +1,6 @@Generic Error for identityprovider-package.
-Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/identityprovider.InvalidAppSessionSignatureError.html b/classes/identityprovider.InvalidAppSessionSignatureError.html index f823305f..2413b930 100644 --- a/classes/identityprovider.InvalidAppSessionSignatureError.html +++ b/classes/identityprovider.InvalidAppSessionSignatureError.html @@ -1,6 +1,6 @@Indicates an invalid sign-value
-Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/logging.DvelopLogger.html b/classes/logging.DvelopLogger.html index 8236a0d1..da902a75 100644 --- a/classes/logging.DvelopLogger.html +++ b/classes/logging.DvelopLogger.html @@ -6,7 +6,7 @@ logs a log statement in the otel log format.Log a message with severity Debug.
Log a message with severity Debug.
A DvelopLogEvent object.
-Log a message with severity Error.
Log a message with severity Error.
A DvelopLogEvent object.
-Log a message with severity Info.
Log a message with severity Info.
A DvelopLogEvent object.
-Generated using TypeDoc
Generated using TypeDoc
Indicates an invalid task-definition. See validation-property for more information.
Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/classes/task.TaskError.html b/classes/task.TaskError.html index 0d37b153..61e68450 100644 --- a/classes/task.TaskError.html +++ b/classes/task.TaskError.html @@ -1,6 +1,6 @@Generic Error for task-package.
-Create .stack property on a target object
Optional override for formatting stack traces
diff --git a/interfaces/business_objects.CreateBoEntityParams.html b/interfaces/business_objects.CreateBoEntityParams.html index 33499d49..88bde50f 100644 --- a/interfaces/business_objects.CreateBoEntityParams.html +++ b/interfaces/business_objects.CreateBoEntityParams.html @@ -2,10 +2,10 @@Parameters for the createBoEntity-function.
Type for Entity. Defaults to any.
Entity to be created
-Name of the model
-EntityName in plural (Singular name won't work)
Generated using TypeDoc
Parameters for the deleteBoEntity-function.
-Type of the key property
-Key-property of the entity to be deleted
-Name of the model
-EntityName in plural (Singular name won't work)
Generated using TypeDoc
Parameters for the getBoEntities-function.
-Name of the model
-EntityName in plural (Singular name won't work)
Generated using TypeDoc
Parameters for the getBoEntity-function.
-Type of the key property
-Key-property of the entity to be retrieved
-Name of the model
-EntityName in plural (Singular name won't work)
Generated using TypeDoc
Parameters for the updateBoEntity-function.
Type for Entity. Defaults to any.
Partial of E. Given properties will be updated.
Type of the key property
-Key-property of the entity to be updated
-Name of the model
-EntityName in plural (Singular name won't work)
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Defines a common d.velop context used across all requests.
-AuthSessionId used for authorization
-RequestId used to track coherent requests over multiple apps
-Signature assigned by the app-router. The requestSignature should be validated for every request when recieving calls from the d.velop cloud. Refer to the d.velop basics tenant header section for more information.
-SystemBaseUri of a tenant
-Id of a tenant
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Parameters for the {@link createDmsObjectNote}-function.
-ID of the DmsObject
-Text for the note
-ID of the repository
Generated using TypeDoc
Parameters for the createDmsObject-function.
-ID of the category for the DmsObject
-File for the DmsObject. This will use the storeFileTemporarily-function and overwrite contentLocationUri-property.
URL at which the file is temporarily stored in the DMS-App. See ... for more information.
-URL from which file can be downloaded. Has to be a relative URL reachable within the tenant
-Name of the file including its file-ending
-Properties
-ID of the repository
-ID of the source. See Mapping for more information.
Generated using TypeDoc
Parameters for the deleteCurrentDmsObjectVersion-function.
-ID of the DmsObject
-Reason for the deletion
-ID of the repository
-ID of the source
Generated using TypeDoc
A d.velop cloud dmsObject.
-Category of the DmsObject
-ID of the DmsObject
-Properties of the DmsObject
-ID of the repository
-ID of the source
-Function that returns the DmsObject-file.
-Function that returns the notes of a DmsObject.
-Function that returns the DmsObject-pdf.
-Function that returns a searchresult of all children.
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Parameters for the getDmsObjectNotes-function.
-ID of the DmsObject
-ID of the repository
Generated using TypeDoc
Parameters for the getDmsObject-function.
-ID of the DmsObject
-ID of the repository
-ID of the source
Generated using TypeDoc
Parameters for the getMappings-function.
-ID of the repository
-ID of the source
Generated using TypeDoc
Parameters for the getRepository-function.
-Id of the repository
Generated using TypeDoc
Parameters for the linkDmsObjects-function.
-ID of the DmsObjects that will be linked as children
-ID of the DmsObject that will be linked as parent
-ID of the repository
-ID of the source
Generated using TypeDoc
A listed version of d.velop cloud dmsObject. There might be more information available via the getDmsObject-function.
-Category of the DmsObject
-ID of the DmsObject
-Properties of the DmsObject
-ID of the repository
-ID of the source
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Parameters for the searchDmsObjects-function.
-Properties
-Generated using TypeDoc
Generated using TypeDoc
Page of a searchResult. There might be more than one page.
-Array of ListedDmsObjects found
-Current page-number
-Function that returns the next page. Undefined if there is none.
-Function that returns the previous page. Undefined if there is none.
Generated using TypeDoc
Parameters for the storeFileTemporarily-function.
-File-binary as ArrayBuffer
-Id of the repository
Generated using TypeDoc
Parameters for the unlinkDmsObjects-function.
-ID of the DmsObjects that will be linked as children
-ID of the DmsObject that will be linked as parent
-ID of the repository
-ID of the source
Generated using TypeDoc
Parameters for the updateDmsObject-function.
-Description of changes
-Id of a category to which the dmsObject should be moved
-File for the DmsObject. This will use the storeFileTemporarily-function and overwrite contentLocationUri-property.
URL at which the file is temporarily stored in the DMS-App. See ... for more information.
-URL from which file can be downloaded. Has to be a relative URL reachable within the tenant
-ID of the DmsObject
-Name of the file including its file-ending
-Property-Updates - Only listed properties will be changed
-ID of the repository
-ID of the source
Generated using TypeDoc
Parameters for the updateDmsObjectStatus-function.
-Description of changes
-ID of the DmsObject
-User or Group to which the DmsObject will be assigned. You can specify individual users as well as groups using IDs of the Identityprovider-App
-ID of the repository
-State of the dms Object
Generated using TypeDoc
AppSession which will be postet to your app after using the requestAppSession-function.
-Generated using TypeDoc
Generated using TypeDoc
Id of a tenant
Generated using TypeDoc
Generated using TypeDoc
User representation according to the System for Cross-domain Identity Management (SCIM).
-Display name assigned by the administrators
-E-Mail addesses
-Groups assigned to the user
-Unique UserId
-Name object containg family name and given name
-Photos for the user usually provided by URL in value
-Technical username
Generated using TypeDoc
Parameters for the getImpersonatedAuthSessionId-function.
-Generated using TypeDoc
Generated using TypeDoc
Parameters for the requestAppSession-function.
-Name of the app requesting the appSession
-Relative URI to which the appSession will be sent via POST
Generated using TypeDoc
Information about outbound db requests.
-measures the duration of the db request in milliseconds.
-This attribute is used to report the name of the database being accessed. For example customers oder main.
-The name of the operation being executed, e.g. the MongoDB
command name such as findAndModify, or the SQL keyword.
For example findAndModify; HMSET; SELECT.
The database statement being executed. Must be sanitized to
exclude sensitive information.
For example SELECT * FROM wuser_table; SET mykey "WuValue".
Several options for a log statement, that can be used by logging providers.
-Set custom attributes that can be used by a logging provider.
-Database request.
-An error.
-Incoming http request.
-Response of an incoming http request.
-Outgoing http request.
-Response of an outgoing http request.
-Specifies if the the logstatement is visible for tenant owner / customer.
-A value containing the body of the log record. Can be for example a human-readable string message (including multi-line) describing the event in a free form or it can be a structured data composed of arrays and maps of other values. Can vary for each occurrence of the event coming from the same source.
-Short event identifier that does not contain varying parts.
Name describes what happened (e.g. "ProcessStarted"). Recommended to be
no longer than 50 characters. Not guaranteed to be unique in any way.
diff --git a/interfaces/logging.DvelopLoggerOptions.html b/interfaces/logging.DvelopLoggerOptions.html
index cd3c16fa..4a01291b 100644
--- a/interfaces/logging.DvelopLoggerOptions.html
+++ b/interfaces/logging.DvelopLoggerOptions.html
@@ -1,3 +1,3 @@
Options needed to create a new DvelopLogger
-Generated using TypeDoc
Generated using TypeDoc
Information about http responses
-Measures the duration of an outgoing HTTP request in milliseconds.
-HTTP request method in upper case. For example GET, POST, DELETE
-The matched route (path template). For example /users/:userID.
Only relevant for responses of incoming http requests
Measures the duration of an incoming HTTP request in milliseconds.
-HTTP response status code
-Full HTTP request URL in the form scheme://host[:port]/path?query[#fragment].
Usually the fragment is not transmitted over HTTP, but if it is known,
it should be included nevertheless.
Information about incoming http requests
-The IP address of the original client behind all proxies, if known (e.g. from X-Forwarded-For).
-Values of some http headers.
Value of the HTTP User-Agent header sent by the client.
-HTTP request method in upper case. For example GET, POST, DELETE
-The matched route (path template). For example /users/:userID
Full HTTP request URL in the form scheme://host[:port]/path?query[#fragment].
Usually the fragment is not transmitted over HTTP, but if it is known,
it should be included nevertheless.
Options for the otel provider.
-Name of your app. Is included in every log statement.
-Version string of your app. If set, it is included in every log statement.
-ID of the current instance of your app. If set, it is included in every log statement.
-Transport options for logging.
Generated using TypeDoc
Information about outgoing http requests
-Values of some http headers.
-HTTP request method in upper case. For example GET, POST, DELETE
-Full HTTP request URL in the form scheme://host[:port]/path?query[#fragment].
Usually the fragment is not transmitted over HTTP, but if it is known,
it should be included nevertheless.
Parameters for the completeTask-function.
-Location-URI of the task.
Generated using TypeDoc
Parameters for the createTask-function.
-Links to the task
This URI is displayed as an action in the user interface to display additional information for the user.
@@ -12,7 +12,7 @@This URI provides an editing dialog for the task. You can find further details in the section Adding editing dialogs.
This URI represents the process by which the task was initiated. The process is displayed in the user interface as a separate perspective for the task. To display completed tasks, the resource has to implement a HEAD request, if the resource is behind the same base address.
-Configuration of actions in the user interface
Context for claim button. Possible values are "list" & "details"
@@ -20,9 +20,9 @@Context for complete button. Possible values are "list" & "details"
Context for forward button. Possible values are "list" & "details"
-The recipients of the task. You can specify individual users as well as groups using IDs of the Identityprovider-App
-The context of a task
A technical identifier for the context
@@ -30,33 +30,33 @@Display name of the context
Type of the context
-The correlation key ensures that only one task is created for this unique key. If a task already exists with the passed key, a new task will not be created.
-A descriptive text of the task
-DmsObject that references the task.
ID of the DmsObject
ID of the repository
-Due date of the task. If you transfer a date without a timestamp, the due date is the transferred date at 00:00:00.
-Metadata for the task. See the documentation for further information
-Priority between 0 (low) and 100 (high)
-Reminder date. If you transfer a date without a timestamp, the reminder date is the transferred date at 00:00:00.
-Specify how long the task details should be kept after completing the task. Valid values are between 0 and 365 days. After this time has passed, the task details will be deleted automatically. The information is specified as a time span in days according to ISO-8601, e.g. P30D for 30 days. Specify the time span P0D if the task details should be deleted immediately after the task is completed. If you make no specification, 30 days are automatically assumed.
-Specifies if a notification should be sent to the task creator when the task is completed. Default is false.
-Specifies if a notification should be sent to the task creator when the task is created. Default is true.
-Specifies if a notification should be sent to the task creator when the due date is exceeded. This option is only available if a dueDate is specified. Default is false.
-The subject of the task
Generated using TypeDoc
Parameters for the deleteTask-function.
-Location-URI of the task.
Generated using TypeDoc
Generated using TypeDoc
A result page returned by the searchTasks function.
+Tasks that match the search parameters
+Gets the next page for this search. Undefined if there is none
+Generated using TypeDoc
Parameters for the searchTasks-function.
+Optional search criteria.
+Search for recipient. Minimum 1 character, maximum 255.
+Search for attachment. Minimum 1 character, maximum 1.000.
+Search for completion date. Date format according to RFC3339. You can only search for a range.
+Search for user who completed the task. Minimum 1 character, maximum 255.
+Search for context key. Max. 255 characters.
+Search for context name. Max. 255 characters.
+Search for context type. Max. 255 characters.
+Search for DMS object ID. Minimum 1 character, maximum 100.
+Search for DMS repository ID. Minimum 1 character, maximum 100.
+Search for due date. Date format according to RFC3339. You can only search for a range.
+Search for metadata. Can contain any quantity of metadata. +You can only use metadata of the type “STRING” for the search.
+Search entry for an individual piece of metadata. Minimum 1 character, maximum 255. The key contains a minimum of 1 character, maximum 255.
+Search for priority. Between 0 and 100. You can search for individual priorities (.e.g.: [50]) or priority ranges (e.g. [“[5 to 50]”]).
+Search for date received. Date format according to RFC3339. You can only search for a range.
+Search for reminder date. Date format according to RFC3339. You can only search for a range.
+Search for sender. Minimum 1 character, maximum 255.
+Search for state. Permitted values: OPEN and COMPLETED.
+Search for subject. Minimum 1 character, maximum 255.
+Value used to sort the results. Permitted values: received, subject, priority and dueDate.
+Specified sort order. Permitted values: ASC for sorting in ascending order and DESC for sorting in descending order.
+Number of tasks per page in the results. Maximum 100.
+Generated using TypeDoc
Validation for task
-Generated using TypeDoc
Generated using TypeDoc
Parameters for the updateTask-function.
-Links to the task
This URI is displayed as an action in the user interface to display additional information for the user.
@@ -12,7 +12,7 @@This URI provides an editing dialog for the task. You can find further details in the section Adding editing dialogs.
This URI represents the process by which the task was initiated. The process is displayed in the user interface as a separate perspective for the task. To display completed tasks, the resource has to implement a HEAD request, if the resource is behind the same base address.
-Configuration of actions in the user interface
Context for claim button. Possible values are "list" & "details"
@@ -20,9 +20,9 @@Context for complete button. Possible values are "list" & "details"
Context for forward button. Possible values are "list" & "details"
-The recipients of the task. You can specify individual users as well as groups using IDs of the Identityprovider-App
-The context of a task
A technical identifier for the context
@@ -30,35 +30,35 @@Display name of the context
Type of the context
-The correlation key ensures that only one task is created for this unique key. If a task already exists with the passed key, a new task will not be created.
-A descriptive text of the task
-DmsObject that references the task
ID of the DmsObject
ID of the repository
-Due date of the task. If you transfer a date without a timestamp, the due date is the transferred date at 00:00:00.
-Location-URI of the task
-Metadata for the task. See the documentation for further information
-Priority between 0 (low) and 100 (high)
-Reminder date. If you transfer a date without a timestamp, the reminder date is the transferred date at 00:00:00.
-Specify how long the task details should be kept after completing the task. Valid values are between 0 and 365 days. After this time has passed, the task details will be deleted automatically. The information is specified as a time span in days according to ISO-8601, e.g. P30D for 30 days. Specify the time span P0D if the task details should be deleted immediately after the task is completed. If you make no specification, 30 days are automatically assumed.
-Specifies if a notification should be sent to the task creator when the task is completed. Default is false.
-Specifies if a notification should be sent to the task creator when the task is created. Default is true.
-Specifies if a notification should be sent to the task creator when the due date is exceeded. This option is only available if a dueDate is specified. Default is false.
-The subject of the task
Generated using TypeDoc
Validate a cloud-center-event-signature against your appSecret.
The cloud-center-event-signature should be validated for every cloud-center-event. Refer to the d.velop cloud center API for more information.
Validate a request-signature against your appSecret.
The requestSignature should be validated for every request when recieving calls from the d.velop cloud. Refer to the d.velop basics tenant header section for more information.
validateDvelopContext(process.env.APP_SECRET, {
systemBaseUri: "https://header.example.com",
tenantId: "a12be5",
requestId: "Zjcf28p5aQ6amtbs6s9b9cPyBPdziwUslR2DZqaGUTQ="
);
@throws <a href="../classes/app_router.InvalidRequestSignatureError.html">InvalidRequestSignatureError</a> indicates that requestSignature was invalid for given appSecret.
Validate a request-signature against your appSecret.
The requestSignature should be validated for every request when recieving calls from the d.velop cloud. Refer to the d.velop basics tenant header section for more information.
diff --git a/modules/business_objects.html b/modules/business_objects.html index 029a5970..7e3a61c2 100644 --- a/modules/business_objects.html +++ b/modules/business_objects.html @@ -20,7 +20,7 @@Create a business object entity.
Type for Entity. Defaults to any.
Delete a business object entity.
Returns all specified entities from a model.
Type for Entity. Defaults to any.
Returns one specified entity from a model.
Type for Entity. Defaults to any.
Update a business object entity.
RequestSignature is invalid for given appSecret.
-