Members
concurrency :Number
maximum amount of concurrent requests to send.
- Source:
Type:
-
Number
server :String
The client FileMaker Server.
- Source:
Type:
-
String
sessions :Array
Open Data API sessions.
- Source:
- See:
Type:
-
Array
starting :Boolean
Open Data API sessions.
- Source:
- See:
Type:
-
Boolean
version :String
The version of Data API to use.
- Source:
Type:
-
String
Methods
(static) authentication(request) → {String}
the authentication method merges the request passed to it with authentication headers. This method is used to ensure requests are sent with the latest available session authentication.
- Source:
- See:
-
Connection#available
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
request |
Object
|
The request to inject the authentication header
|
Returns:
- Type:
-
String
The session token.
(static) available() → {Boolean|Class}
Saves a token retrieved from the Data API as a sessions
- Source:
- See:
-
session
Returns:
- Type:
-
Boolean|Class
data a false boolean or session
(static) clear(headeropt)
clears the currently saved token, expiration, and issued data by setting them to empty strings. This method returns whatever is passed to it unmodified.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
header |
String
|
<optional> |
The header containing the token to clear. |
(static) end(agentopt, idopt) → {String}
ends a FileMaker Data API session and clears the session.
- Source:
- See:
-
Connection#clear
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
agent |
Object
|
<optional> |
An optional custom request agent. |
id |
String
|
<optional> |
The session id to log out. |
Returns:
- Type:
-
String
The session token.
(static) extend(headeropt)
Saves a token retrieved from the Data API. This method returns the response recieved to it unmodified.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
header |
String
|
<optional> |
The header containing the token to clear. |
(static) ready() → {Boolean}
Saves a token retrieved from the Data API as a sessions
- Source:
- See:
-
session
Returns:
- Type:
-
Boolean
data a boolean indicating if the connection has a session.
(static) save(data) → {String}
Saves a token retrieved from the Data API as a sessions
- Source:
- See:
-
session
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object
|
The FileMaker authentication response. |
Returns:
- Type:
-
String
a token retrieved from the private generation method
(static) starts(agentopt) → {String}
Starts a FileMaker Data API session
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
agent |
Object
|
<optional> |
An optional custom request agent. |
Returns:
- Type:
-
String
The session token.