Constructor
new FlexSession(options)
Parameters:
| Name |
Type |
Description |
options |
Object
|
Properties
| Name |
Type |
Attributes |
Default |
Description |
protocol |
string
|
<optional>
|
https
|
The protocol used for the FlexVertex REST endpoints |
hostname |
string
|
<optional>
|
localhost
|
The hostname of the FlexVertex REST endpoints |
port |
string
|
<optional>
|
8000
|
If hostname is 'localhost', then port defaults to 8000 |
username |
string
|
|
|
Either the full /D/N/S/Username or an email address |
password |
string
|
|
|
An unencoded password |
timeout |
string
|
<optional>
|
30000
|
How long (in milliseconds) each REST call has before timing out (defaults to 30000) |
|
Classes
- FlexSession
Methods
close()
Called when the FlexSession is no longer needed.
openSchema(dnsPath) → {FlexSchema}
Parameters:
| Name |
Type |
Description |
dnsPath |
string
|
The /Domain/Nexus/Schema path to open |
Returns:
-
Type
-
FlexSchema