# DeepLinkModule

The `DeepLinkModule` class exposes methods and properties to read the values that an external app sent to an effect.

## Example

```
//==============================================================================
// The following example demonstrates how to retrieve data passed in to an
// effect from an external app.
//
// Note: This example is based on an external app sending a 'name' argument.
//==============================================================================

// Load in the required modules
const DeepLink = require('DeepLink');
const Diagnostics = require('Diagnostics');

// Store a reference to the name argument passed from an external app
let name = DeepLink.arguments.name;

// If the name argument does not exist then set a default value
if (!name) {
    name = 'Jane Doe';
}

// Log the name
Diagnostics.log(name);
```

## Properties

| Property    | Description                                                                                                                                                        |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `arguments` | <p><code>(get) arguments: { \[key: string]: Object} (set) (Not Available)</code></p><p>Specifies a collection of key/value pairs passed from the external app.</p> |

## Methods

This module exposes no methods.

## Classes

This module exposes no classes.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://sparkar-community.gitbook.io/docs/deeplinkmodule.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.