@resconet/qp-bridge 0.0.1-alpha.17 → 0.0.1-alpha.19

package/README.md

@@ -41,6 +41,18 @@ await setAnswer("numericQuestion", 42);
 
 ## Functions
 
+- [createMediaItem](#createmediaitem)
+- [createMediaItem](#createmediaitem)
+- [createMediaItem](#createmediaitem)
+- [createMediaItem](#createmediaitem)
+- [createMediaItem](#createmediaitem)
+- [createMediaItem](#createmediaitem)
+- [updateMediaItem](#updatemediaitem)
+- [updateMediaItem](#updatemediaitem)
+- [updateMediaItem](#updatemediaitem)
+- [updateMediaItem](#updatemediaitem)
+- [updateMediaItem](#updatemediaitem)
+- [updateMediaItem](#updatemediaitem)
 - [setAnswer](#setanswer)
 - [getQuestion](#getquestion)
 - [setQuestion](#setquestion)
@@ -53,6 +65,324 @@ await setAnswer("numericQuestion", 42);
 - [executeCustomCommand](#executecustomcommand)
 - [onSave](#onsave)
 
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### createMediaItem
+
+Creates a MediaItem from the provided parameters and content.
+
+| Function | Type |
+| ---------- | ---------- |
+| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
+
+Parameters:
+
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
+* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as Blob.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as base64 string or binary string.
+* `name`: - Name of the media item.
+* `mimeType`: - MIME type of the media item.
+* `content`: - Content as ArrayBuffer.
+
+
+Returns:
+
+MediaItem object with blobUrl generated from the content.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
+
+### updateMediaItem
+
+Updates a MediaItem with the provided changes. If content is provided, blobUrl will be updated accordingly.
+
+| Function | Type |
+| ---------- | ---------- |
+| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
+
+Parameters:
+
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing properties to update (name, mimeType, content).
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as Blob.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as base64 string or binary string.
+* `mediaItem`: - The original MediaItem to update.
+* `updates`: - Object containing content as ArrayBuffer.
+
+
+Returns:
+
+Updated MediaItem object.
+
 ### setAnswer
 
 Sets the answer for a specific question in the questionnaire.