---
title: "Deluge Object Reference"
url: https://docs.catalyst.zoho.com/en/convokraft/help/actions/bot-logic/deluge-functions/deluge-object-reference/
description: "Learn about Deluge functions and use them to code the business logic of your ConvoKraft bot."
last_updated: 2023-07-20T08:09:11Z
service: ConvoKraft
type: general
---

# Deluge Object Reference

The Deluge Object Reference documentation aims to give a detailed idea about the various elements of the Deluge functions in ConvoKraft. The core objects supported by ConvoKraft include the data access objects, input objects, and response objects. We will be discussing each of them in detail in this section.

# Data Access objects

### sessionData

The details about the current chat session of the client. This data will be available for all functions under the `sessionData` argument.

<table class="content-table">
        <thead>
            <tr>
                <th>Deluge Data type</th>
                <th>Availability</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`Map`</td>
                <td>In all functions</td>
            </tr>
            </tbody>
</table>

This argument comprises the following keys: 

<table class="content-table">
        <thead>
            <tr>
                <th>Key name</th>
                <th>Deluge data type</th>
                <th>Description</th>
                <th>Sample value</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`medium`</td>
                <td>Text</td>
                <td>The mode of communication through which the user interacts with the bot.  The possible values are `call` or `chat`. </td>
                <td>chat</td>
            </tr>
            <tr>
                <td>`client_host`</td>
                <td>Text</td>
                <td>The nature of the client application that hosts the bot. The possible values are `mobile` or `web`.</td>
                <td>web</td>
            </tr>
            <tr>
                <td>`client_identifier`</td>
                <td>Text</td>
                <td>The unique identifier of the client.

                The URL of the web application, if `client_identifier` is `web`.

                The package name bundle identifier of the mobile application, if `client_identifier` is `mobile`.
                </td>
                <td>https://zylker.com</td>
            </tr>
            <tr>
                <td>`client_data`</td>
                <td>Map</td>
                <td>The data passed from the client to ConvoKraft at the start of the session.</td>
                <td>{
                    "user_email":
                    "todd@hmail.com"
                    }</td>
            </tr>
            </tbody>
</table>

### cache

The `cache` object acts as a temporary storage variable. Any data stored in this object in the form of key-value pair will be accessible across all the functions of the currently executing action until that action execution completes.

<table class="content-table">
        <thead>
            <tr>
                <th>Deluge Data type</th>
                <th>Availability</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`Map`</td>
                <td>In all functions</td>
            </tr>
            </tbody>
</table>

### broadcast

If you want your bot to remember any information related to the current executing action, the information can be stored in the `broadcast` object. This value will be retained even after the execution of the current action, and will be available for all subsequent actions until the current chat session is over. Subsequent actions can use this value, as required by business logic.

<table class="content-table">
        <thead>
            <tr>
                <th>Deluge Data type</th>
                <th>Availability</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`Map`</td>
                <td>In all functions</td>
            </tr>
            </tbody>
</table>

#### messageData

The `messageData` object contains the custom message sent by the client for each transcript (a message in the bot conversation) request in the `data` key.

<table class="content-table">
        <thead>
            <tr>
                <th>Deluge Data type</th>
                <th>Availability</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>`Map`</td>
                <td>In all functions</td>
            </tr>
            </tbody>
</table>

# Input Objects

### param

The input values provided by the user for each static param would be captured under the objects with the same param name across the Deluge functions.

<table class="content-table">
        <thead>
            <tr>
                <th>Deluge Data type</th>
                <th>Availability</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>corresponding param's data type</td>
                <td>In Context handler function and Action execution function</td>
            </tr>
            </tbody>
</table>

### previousParam

The `previousParam` object contains the param that was last prompted to the user. The latest  reply of the user will be set as a value to this param.

<table class="content-table">
        <thead>
            <tr>
                <th>Deluge Data type</th>
                <th>Availability</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>corresponding param's data type</td>
                <td>Only in Context Handler function</td>
            </tr>
            </tbody>
</table>

# Response Objects

### card

The card can be used to give a visually formatted message as a reply to the user. A card is a collection of visual elements, such as tables and images. The value of this key is a list of map objects. Each map object represents an UI element in the card. A single card may contain more than one element of the same type. Every element in the card will be displayed one below the other in the [reply message](https://docs.catalyst.zoho.com/en/convokraft/help/actions/bot-logic/deluge-functions/execution-function/#message). 

The inline formatting options such as `Bold`, `Italic`, `Underline`, `Strikethrough`, `Link`, and `Highlight` are applicable to the card elements as well. So, any of these above mentioned formatting options can be used in the text values in any of the below cards.

The following UI elements are supported in ConvoKraft's reply message card :

<table class="content-table">
        <thead>
            <tr>
                <th class="w90p">Element</th>
                <th class="w70p">Format</th>
            </tr>
        </thead>
        <tbody>
            <tr>
<td>`Note`</td>
<td>

****

```
{
    "type" : "note",
    "content" : "&lt;Text content that needs to be displayed as a note.&gt;"
}
```

</td>
            </tr>
            <tr>
 <td>`Title`</td>
<td>

****

```
{
    "type" : "title",
    "content" : "&lt;Text content that needs to be displayed as the title&gt;"
}
```

</td>
            </tr>
            <tr>
<td>`List - Bullet & Numbered`</td>
<td>

****

```
{ 
    "type" : "list",
    "format" : "bullet" or "numbered" 
    "elements" : [
    {
    "label" : "&lt;element_label&gt;"
    "preview" : {
    "header" : {
    "title" : "&lt;title_content&gt;"
    "description" : "&lt;description_content&gt;",
    "subheading" : "&lt;subheading_content&gt;",
    "image" : {
    "url" :"&lt;image_url&gt;"
}
    },
    "fields" :[
    {
    "label" : "&lt;field labels&gt;"
    "value" : "&lt;field values&gt;"
    } //add other fields as necessary
    ]
    }
    } //add other elements as necessary
    ]
}
```

> **Note : ** In the `list` card, a maximum of seven fields can be configured for a `preview` object. 

</td>
</tr>

<tr>
<td>`Table`</td>
<td>

****

```
{
"type": "table",
"heading" : "&lt;Table Heading&gt;",
"columns":
[
"&lt;column1 header&gt;".
"&lt;column2 header&gt;"
"&lt;column3 header&gt;"
], 
"rows":
[
[
"&lt;value al&gt;"
"&lt;value a2&gt;"
"&lt;value a3&gt;"
],
[
"&lt;value b1&gt;"
"&lt;value b2&gt;"
"&lt;value b3&gt;"
]
]
}

```

</td>
</tr>

<td>`Image`</td>
<td>

****

```
{
"type" : "image",
"content" : "&lt;image url&gt;"
}
```

</td>
</tr>
<tr>
<td>`File`</td>
<td>

****

```
{
"type" : "file",
"name" : "&lt;file_name&gt;",
"format" : "pdf", //file extension
"content": "&lt;file url&gt;"
}
```

</td>
</tr>
<tr>
<td>`Contact card`</td>
<td>

****

```
{
"type" : "vcard",
"info" :
{
"image" : "<image url>",
"fields" :
[
{
"First Name" : "Smith"
}.
{
"Last Name" : "Gibbs"
},
{
"Company": "ABC Corp"
},
{
"Website" : "https://"
}
]
}
}

```

</td>
</tr>
<tr>
<td>`Link`</td>
<td>

****

```
{
"type" : "label",
"content" : "&lt;URL link&gt;"
}

```

</td>
</tr>
<tr>
<td>`Button`</td>
<td>

****

```
{
"type" : "button",
"label" : "&lt;button label&gt;".
"theme" : "&lt;button theme&gt;"
"id" : "&lt;button id&gt;",
"onclick" : 
{
"execute" : "function (or)clienthook",
"function":"&lt;button click function name&gt;",
"data" : {}
}
}

```

1. For `theme` key, the value can be either `positive`, `negative`, or `neutral`.
2. For `execute` key, the value can be any one of the following:
* `function` - to execute the defined Button Click function.
* `clienthook` - to execute the [hook](https://docs.catalyst.zoho.com/en/convokraft/sdk/js/hooks/) implemented by the client application.

    If `clienthook` is set as the value to the `execute` key, then the `function` key is not required.
4. For the `data` key, set any value that needs to be passed to the button click function.

> **Note : ** A maximum of three buttons can be configured for an action using the `button` card.

</td>
</tr>
</tbody>
</table>