getSettings

Parameters:

  • Profile - name of the profile. To get System Wide Settings, use !SYSTEM

  • Name (optional) - array of setting names to get. If no Name is provided, all settings are returned.

  • TestOrLive (optional) - whether to return the test settings, or live settings. Returns live settings by default.

Returns:

  • Setting - an array of name/value pairs for the requested settings. A TestOrLive attribute on the settings indicate whether this applies to test, live, or both.

Gets a list of settings for the requested profile. You can request one or more specific settings by passing in Name parameters, or get all settings by not supplying a Name.

Some settings have test and live versions. You can request which version you'd like (defaults to live), and the returned settings indicate whether they apply to test or live. "Both" indicates that setting doesn't have different test and live versions.


Copyright © Thunderstone Software     Last updated: Dec 10 2018
Copyright © 2019 Thunderstone Software LLC. All rights reserved.