Skip to content
Merged
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
6 changes: 6 additions & 0 deletions docs/API/BlobClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ title: Blob

The Blob class lets you create and manipulate [blob objects](../Concepts/dt_blob.md#blob-types) (`4D.Blob`).

:::info

This class is [**streamable**](../Concepts/dt_object.md#binary-streaming-variable-to-blob) in binary.

:::

### Summary

||
Expand Down
5 changes: 5 additions & 0 deletions docs/API/CollectionClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ The Collection class manages [Collection](Concepts/dt_collection.md) type expres
A collection is initialized with the [`New collection`](../commands/new-collection) or [`New shared collection`](../commands/new-shared-collection) commands.


:::info

This class is [**streamable**](../Concepts/dt_object.md#binary-streaming-variable-to-blob) in binary.

:::

### Example

Expand Down
7 changes: 7 additions & 0 deletions docs/API/EmailObjectClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,13 @@ You send `Email` objects using the SMTP [`.send()`](SMTPTransporterClass.md#send

[`MAIL Convert from MIME`](../commands/mail-convert-from-mime) and [`MAIL Convert to MIME`](../commands/mail-convert-to-mime) commands can be used to convert `Email` objects to and from MIME contents.

:::info

This class is [**streamable**](../Concepts/dt_object.md#binary-streaming-variable-to-blob) in binary.

:::


### Email Object

Email objects provide the following properties:
Expand Down
8 changes: 8 additions & 0 deletions docs/API/FileClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ title: File

`File` objects are created with the [`File`](../commands/file) command. They contain references to disk files that may or may not actually exist on disk. For example, when you execute the `File` command to create a new file, a valid `File` object is created but nothing is actually stored on disk until you call the [`file.create( )`](#create) function.


:::info

This class is [**streamable**](../Concepts/dt_object.md#binary-streaming-variable-to-blob) in binary.

:::


### Example

The following example creates a preferences file in the project folder:
Expand Down
2 changes: 1 addition & 1 deletion docs/API/FileHandleClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ Object resources, such as documents, are released when no more references exist

:::


### Example

```code4d
Expand Down Expand Up @@ -57,6 +56,7 @@ End while

```


### FileHandle object

File handle objects cannot be shared.
Expand Down
8 changes: 8 additions & 0 deletions docs/API/FolderClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ title: Folder

`Folder` objects are created with the [`Folder`](../commands/folder) command. They contain references to folders that may or may not actually exist on disk. For example, when you execute the `Folder` command to create a new folder, a valid `Folder` object is created but nothing is actually stored on disk until you call the [`folder.create()`](#create) function.


:::info

This class is [**streamable**](../Concepts/dt_object.md#binary-streaming-variable-to-blob) in binary.

:::


### Example

The following example creates a "JohnSmith" folder:
Expand Down
6 changes: 6 additions & 0 deletions docs/API/FormulaClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ title: Formula

See examples in the [Executing code in Function objects](../API/FunctionClass.md#executing-code-in-function-objects) paragraph.

:::info

This class is [**streamable**](../Concepts/dt_object.md#binary-streaming-variable-to-blob) in binary.

:::


### Passing parameters to formulas

Expand Down
6 changes: 6 additions & 0 deletions docs/API/MailAttachmentClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ title: MailAttachment

Attachment objects allow referencing files within a [`Email`](EmailObjectClass.md) object. Attachment objects are created using the [`MAIL New attachment`](../commands/mail-new-attachment) command.

:::info

This class is [**streamable**](../Concepts/dt_object.md#binary-streaming-variable-to-blob) in binary.

:::


### Attachment Object

Expand Down
6 changes: 6 additions & 0 deletions docs/API/MethodClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ See examples in the [Executing code in Function objects](../API/FunctionClass.md

:::

:::info

This class is [**streamable**](../Concepts/dt_object.md#binary-streaming-variable-to-blob) in binary.

:::


### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/API/SessionClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Session objects are returned by the [`Session`](../commands/session) command. Th
- [Scalable sessions for advanced web applications](https://blog.4d.com/scalable-sessions-for-advanced-web-applications/)
- [Permissions: Inspect Session Privileges for Easy Debugging](https://blog.4d.com/permissions-inspect-session-privileges-for-easy-debugging/)
- [Generate, share and use web sessions One-Time Passcodes (OTP)](https://blog.4d.com/connect-your-web-apps-to-third-party-systems/)
- [Client / server – Handle a session when working on a 4D client](https://blog.4d.com/client-server-handle-a-session-when-working-on-a-4d-client)
- [Forget server-side wrappers, use 4D Sessions from the client](https://blog.4d.com/forget-server-side-wrappers-use-4d-sessions-from-the-client)

:::

Expand Down
4 changes: 4 additions & 0 deletions docs/API/VectorClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ The `Vector` class allows you to handle **vectors** and to execute distance and
In the world of AIs, a vector is a sequence of numbers that enables a machine to understand and manipulate complex data. For a detailed overview of the role of vectors with AIs, you can refer to [this page](https://aiforsocialgood.ca/blog/understanding-the-role-of-vectors-in-artificial-intelligence-a-comprehensive-guide).


:::info

This class is [**streamable**](../Concepts/dt_object.md#binary-streaming-variable-to-blob) in binary.

:::

### Understanding the different vector computations

Expand Down
7 changes: 5 additions & 2 deletions docs/API/WebServerClass.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,17 @@ title: WebServer

The `WebServer` class API allows you to start and monitor a web server for the main (host) application as well as each hosted component (see the [Web Server object](WebServer/webServerObject.md) overview). This class is available from the `4D` class store.

### Properties

- **Streamable**: no
- **Sharable**: no

### Web Server object

Web server objects are instantiated with the [`WEB Server`](../commands/web-server) command.

They provide the following properties and functions:

### Summary

||
|---|
|[<!-- INCLUDE #WebServerClass.accessKeyDefined.Syntax -->](#accesskeydefined)<br/><!-- INCLUDE #WebServerClass.accessKeyDefined.Summary -->|
Expand Down
Loading
Loading