UNPKG

streamdeck-typescript

Version:

This library will help you build elgato stream deck plugins in typescript

705 lines 36.2 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>SettingsManager | streamdeck-typescript - v3.2.1</title> <meta name="description" content="Documentation for streamdeck-typescript - v3.2.1"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script async src="../assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">streamdeck-typescript - v3.2.1</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../modules.html">streamdeck-typescript - v3.2.1</a> </li> <li> <a href="settingsmanager.html">SettingsManager</a> </li> </ul> <h1>Class SettingsManager</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">SettingsManager</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="settingsmanager.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="settingsmanager.html#cachecontextsettings" class="tsd-kind-icon">cache<wbr>Context<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="settingsmanager.html#cacheglobalsettings" class="tsd-kind-icon">cache<wbr>Global<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="settingsmanager.html#disableautodebounce" class="tsd-kind-icon">disable<wbr>Auto<wbr>Debounce</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="settingsmanager.html#disableautosave" class="tsd-kind-icon">disable<wbr>Auto<wbr>Save</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="settingsmanager.html#getallcontextsettings" class="tsd-kind-icon">get<wbr>All<wbr>Context<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="settingsmanager.html#getcontextsettings" class="tsd-kind-icon">get<wbr>Context<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="settingsmanager.html#getglobalsettings" class="tsd-kind-icon">get<wbr>Global<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="settingsmanager.html#savecontextsettings" class="tsd-kind-icon">save<wbr>Context<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="settingsmanager.html#saveglobalsettings" class="tsd-kind-icon">save<wbr>Global<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="settingsmanager.html#setcontextsettings" class="tsd-kind-icon">set<wbr>Context<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="settingsmanager.html#setcontextsettingsattributes" class="tsd-kind-icon">set<wbr>Context<wbr>Settings<wbr>Attributes</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="settingsmanager.html#setglobalsettings" class="tsd-kind-icon">set<wbr>Global<wbr>Settings</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="settingsmanager.html#setglobalsettingsattributes" class="tsd-kind-icon">set<wbr>Global<wbr>Settings<wbr>Attributes</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Settings<wbr>Manager<span class="tsd-signature-symbol">(</span>_handler<span class="tsd-signature-symbol">: </span><a href="streamdeckhandlerbase.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckHandlerBase</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="settingsmanager.html" class="tsd-signature-type" data-tsd-kind="Class">SettingsManager</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L18">manager/settings.manager.ts:18</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>_handler: <a href="streamdeckhandlerbase.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckHandlerBase</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="settingsmanager.html" class="tsd-signature-type" data-tsd-kind="Class">SettingsManager</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="cachecontextsettings" class="tsd-anchor"></a> <h3>cache<wbr>Context<wbr>Settings</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">cache<wbr>Context<wbr>Settings<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, settings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L193">manager/settings.manager.ts:193</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sets settings without saving it</p> </div> <p>This is deprecated, please use <a href="actionmanager.html">ActionManager</a></p> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>context: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>settings: <span class="tsd-signature-symbol">{}</span></h5> <div class="tsd-comment tsd-typography"> </div> <ul class="tsd-parameters"> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="cacheglobalsettings" class="tsd-anchor"></a> <h3>cache<wbr>Global<wbr>Settings</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">cache<wbr>Global<wbr>Settings<span class="tsd-signature-symbol">(</span>settings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L181">manager/settings.manager.ts:181</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sets global settings without saving it</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>settings: <span class="tsd-signature-symbol">{}</span></h5> <div class="tsd-comment tsd-typography"> </div> <ul class="tsd-parameters"> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="disableautodebounce" class="tsd-anchor"></a> <h3>disable<wbr>Auto<wbr>Debounce</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">disable<wbr>Auto<wbr>Debounce<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L32">manager/settings.manager.ts:32</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Disables automatic debounce</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="disableautosave" class="tsd-anchor"></a> <h3>disable<wbr>Auto<wbr>Save</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">disable<wbr>Auto<wbr>Save<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L25">manager/settings.manager.ts:25</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Disables automatic save</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a name="getallcontextsettings" class="tsd-anchor"></a> <h3>get<wbr>All<wbr>Context<wbr>Settings</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">get<wbr>All<wbr>Context<wbr>Settings&lt;Settings&gt;<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Settings</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L93">manager/settings.manager.ts:93</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets <strong>all</strong> context settings</p> </div> <p>This is deprecated, please use <a href="actionmanager.html">ActionManager</a></p> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd></dd> </dl> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>Settings</h4> <div class="tsd-comment tsd-typography"> <p>your settings interface for autocomplete</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Settings</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a name="getcontextsettings" class="tsd-anchor"></a> <h3>get<wbr>Context<wbr>Settings</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">get<wbr>Context<wbr>Settings&lt;Settings&gt;<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Settings</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L81">manager/settings.manager.ts:81</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets context settings</p> </div> <p>This is deprecated, please use <a href="actionmanager.html">ActionManager</a></p> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd></dd> </dl> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>Settings</h4> <div class="tsd-comment tsd-typography"> <p>your settings interface for autocomplete</p> </div> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>context: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>the context of the action</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Settings</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a name="getglobalsettings" class="tsd-anchor"></a> <h3>get<wbr>Global<wbr>Settings</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">get<wbr>Global<wbr>Settings&lt;GlobalSettings&gt;<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalSettings</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L41">manager/settings.manager.ts:41</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Gets global settings</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>GlobalSettings</h4> <div class="tsd-comment tsd-typography"> <p>your settings interface for autocomplete</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">GlobalSettings</span></h4> <p>| GlobalSettings}</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="savecontextsettings" class="tsd-anchor"></a> <h3>save<wbr>Context<wbr>Settings</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">save<wbr>Context<wbr>Settings<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, ms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L159">manager/settings.manager.ts:159</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Save context settings</p> </div> <p>This is deprecated, please use <a href="actionmanager.html">ActionManager</a></p> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>context: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>string for specific action or &#39;ALL&#39; for all events</p> </div> </li> <li> <h5>ms: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>for the debounce</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="saveglobalsettings" class="tsd-anchor"></a> <h3>save<wbr>Global<wbr>Settings</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">save<wbr>Global<wbr>Settings<span class="tsd-signature-symbol">(</span>ms<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L139">manager/settings.manager.ts:139</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Save global settings</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>ms: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>for the debounce</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setcontextsettings" class="tsd-anchor"></a> <h3>set<wbr>Context<wbr>Settings</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Context<wbr>Settings<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, settings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, ms<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L106">manager/settings.manager.ts:106</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set context settings</p> </div> <p>This is deprecated, please use <a href="actionmanager.html">ActionManager</a></p> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>context: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>settings: <span class="tsd-signature-symbol">{}</span></h5> <ul class="tsd-parameters"> </ul> </li> <li> <h5>ms: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5> <div class="tsd-comment tsd-typography"> <p>for the debounce</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setcontextsettingsattributes" class="tsd-anchor"></a> <h3>set<wbr>Context<wbr>Settings<wbr>Attributes</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Context<wbr>Settings<wbr>Attributes<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, ms<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L120">manager/settings.manager.ts:120</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Set single or multiple attributes for settings This is deprecated, please use <a href="actionmanager.html">ActionManager</a></p> </div> <dl class="tsd-comment-tags"> <dt>deprecated</dt> <dd></dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>context: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>Single or multiple attributes</p> </div> </li> <li> <h5>attributes: <span class="tsd-signature-symbol">{}</span></h5> <ul class="tsd-parameters"> </ul> </li> <li> <h5>ms: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5> <div class="tsd-comment tsd-typography"> <p>for the debounce</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a name="setglobalsettings" class="tsd-anchor"></a> <h3>set<wbr>Global<wbr>Settings</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <li class="tsd-signature tsd-kind-icon">set<wbr>Global<wbr>Settings&lt;GlobalSettings&gt;<span class="tsd-signature-symbol">(</span>settings<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">GlobalSettings</span>, ms<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L51">manager/settings.manager.ts:51</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sets global settings</p> </div> </div> <h4 class="tsd-type-parameters-title">Type parameters</h4> <ul class="tsd-type-parameters"> <li> <h4>GlobalSettings</h4> <div class="tsd-comment tsd-typography"> <p>your settings interface for autocomplete</p> </div> </li> </ul> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>settings: <span class="tsd-signature-type">GlobalSettings</span></h5> </li> <li> <h5>ms: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5> <div class="tsd-comment tsd-typography"> <p>for the debounce</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setglobalsettingsattributes" class="tsd-anchor"></a> <h3>set<wbr>Global<wbr>Settings<wbr>Attributes</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Global<wbr>Settings<wbr>Attributes<span class="tsd-signature-symbol">(</span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span>, ms<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/manager/settings.manager.ts#L65">manager/settings.manager.ts:65</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Sets single or multiple attributes of the settings</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>attributes: <span class="tsd-signature-symbol">{}</span></h5> <div class="tsd-comment tsd-typography"> <p>single or multiple attributes</p> </div> <ul class="tsd-parameters"> </ul> </li> <li> <h5>ms: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></h5> <div class="tsd-comment tsd-typography"> <p>for the debounce</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class=" "> <a href="../modules.html">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class"> <a href="settingsmanager.html" class="tsd-kind-icon">Settings<wbr>Manager</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="settingsmanager.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="settingsmanager.html#cachecontextsettings" class="tsd-kind-icon">cache<wbr>Context<wbr>Settings</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="settingsmanager.html#cacheglobalsettings" class="tsd-kind-icon">cache<wbr>Global<wbr>Settings</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="settingsmanager.html#disableautodebounce" class="tsd-kind-icon">disable<wbr>Auto<wbr>Debounce</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="settingsmanager.html#disableautosave" class="tsd-kind-icon">disable<wbr>Auto<wbr>Save</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a href="settingsmanager.html#getallcontextsettings" class="tsd-kind-icon">get<wbr>All<wbr>Context<wbr>Settings</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a href="settingsmanager.html#getcontextsettings" class="tsd-kind-icon">get<wbr>Context<wbr>Settings</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a href="settingsmanager.html#getglobalsettings" class="tsd-kind-icon">get<wbr>Global<wbr>Settings</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="settingsmanager.html#savecontextsettings" class="tsd-kind-icon">save<wbr>Context<wbr>Settings</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="settingsmanager.html#saveglobalsettings" class="tsd-kind-icon">save<wbr>Global<wbr>Settings</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="settingsmanager.html#setcontextsettings" class="tsd-kind-icon">set<wbr>Context<wbr>Settings</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="settingsmanager.html#setcontextsettingsattributes" class="tsd-kind-icon">set<wbr>Context<wbr>Settings<wbr>Attributes</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"> <a href="settingsmanager.html#setglobalsettings" class="tsd-kind-icon">set<wbr>Global<wbr>Settings</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="settingsmanager.html#setglobalsettingsattributes" class="tsd-kind-icon">set<wbr>Global<wbr>Settings<wbr>Attributes</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> </body> </html>