[Contents] [Prev] [Next] [Index] [Report an Error]

## Subscription Attributes

Some methods take attributes for subscriptions, as described below.

sessionTimeout

- Timeout for the service.

- Value—Number of seconds in the range –1–2147483647

- Guideline— –1 indicates no timeout.

- Example—600

downstreamBandwidth

- Traffic rate between the subscriber and the network.

- Value—Number of bits per second in the range 0–2147483647

- Example—10000

upstreamBandwidth

- Traffic rate between the network and subscriber.

- Value—Number of bits per second in the range 0–2147483647

- Example—5000

sessionTag

- Tag that the software uses to track a session for accounting purposes.

- Value—Text string

- Example—News:Joe

subscriptionUsername

- Name of the subscriber to the service.

- Value—Text string

- Example—Joe

subscriptionPassword

- Password for the service.

- Value—Text string

- Example—Secret

substitutions

- Attributes and values that the method should substitute for existing settings.

- Value—Array of strings; each array has the format <substutionType>=<substitutionValue>

- Example—Port=9999

[Contents] [Prev] [Next] [Index] [Report an Error]