new Command(command) → {amps.Command}
This is the constructor for the Command class. Below are indentical setter/getter methods for different fields.
Parameters:
Name | Type | Description |
---|---|---|
command |
String | The name of the command. |
Returns:
The created command object.
- Type
- amps.Command
Methods
ackType(value) → {amps.Command|String}
Adds/Returns an acknowledgement type value(s). Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | acknowledgement type value (comma delimited) |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
bookmark(value) → {amps.Command|String}
Adds/Returns a bookmark value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | bookmark value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
clientName(value) → {amps.Command|String}
Adds/Returns a client name value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | the client's name value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
correlationId(value) → {amps.Command|String}
Adds/Returns a correlation id value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | correlation id value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
dataOnly(value) → {amps.Command|String}
Adds/Returns a 'data only' value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | the 'data only' value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
expiration(value) → {amps.Command|String}
Adds/Returns a expiration value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | expiration value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
filter(value) → {amps.Command|String}
Adds/Returns a filter value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | filter value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
options(value) → {amps.Command|String}
Adds/Returns an options value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | options value (a String with options delimited by comma) |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
orderBy(value) → {amps.Command|String}
Adds/Returns an 'order by' value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | 'order by' value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
sendEmpty(value) → {amps.Command|String}
Adds/Returns a 'send empty' value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | the 'send empty' value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
sendKeys(value) → {amps.Command|String}
Adds/Returns a 'send keys' value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | the 'send keys' value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
sendOOF(value) → {amps.Command|String}
Adds/Returns a 'send OOF' (Out-Of-Focus) value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | the 'send OOF' (Out-Of-Focus) value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
sendSubscriptionIds(value) → {amps.Command|String}
Adds/Returns a 'send subscription ids' value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | the 'send subscription ids' value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
sequenceId(value) → {amps.Command|String}
Adds/Returns a sequence id value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | sequence id value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
sowKey(value) → {amps.Command|String}
Adds/Returns a sow key value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | sow key value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
sowKeys(value) → {amps.Command|String}
Adds/Returns the sow keys values. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | sowKeys value (a String with sow keys delimited by comma) |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
subId(value) → {amps.Command|String}
Adds/Returns a subscription id value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | subscription id value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
subscriptionIds(value) → {amps.Command|String}
Adds/Returns the subscription ids value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | the subscription ids value (a String with sow keys delimited by comma) |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
topic(value) → {amps.Command|String}
Adds/Returns a topic value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | topic value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
topic(value) → {amps.Command|String}
Adds/Returns a message data value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | message data value |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String
transmissionTime(value) → {amps.Command|String}
Adds/Returns a transmission time value. Works as a getter if no parameter set.
Parameters:
Name | Type | Description |
---|---|---|
value |
String | transmission time value in seconds |
Returns:
the updated command object / the command value (in case of a getter).
- Type
- amps.Command | String