streamdeck-typescript
Version:
This library will help you build elgato stream deck plugins in typescript
853 lines • 60.8 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>StreamDeckPluginHandler | 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="streamdeckpluginhandler.html">StreamDeckPluginHandler</a>
</li>
</ul>
<h1>Class StreamDeckPluginHandler<GlobalSettings></h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This will help you create the stream deck action handler</p>
</div>
<dl class="tsd-comment-tags">
<dt>author</dt>
<dd><p>XeroxDev <a href="mailto:help@xeroxdev.de">help@xeroxdev.de</a></p>
</dd>
<dt>copyright</dt>
<dd><p>2021</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>GlobalSettings = <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="streamdeckhandlerbase.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckHandlerBase</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GlobalSettings</span><span class="tsd-signature-symbol">></span>
<ul class="tsd-hierarchy">
<li>
<span class="target">StreamDeckPluginHandler</span>
</li>
</ul>
</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 tsd-is-private-protected">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite tsd-is-protected"><a href="streamdeckpluginhandler.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="streamdeckpluginhandler.html#actionmanager" class="tsd-kind-icon">action<wbr>Manager</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#connectionready" class="tsd-kind-icon">connection<wbr>Ready</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#documentready" class="tsd-kind-icon">document<wbr>Ready</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#globalsettingsready" class="tsd-kind-icon">global<wbr>Settings<wbr>Ready</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#info" class="tsd-kind-icon">info</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#port" class="tsd-kind-icon">port</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#registerevent" class="tsd-kind-icon">register<wbr>Event</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#settingsmanager" class="tsd-kind-icon">settings<wbr>Manager</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#uuid" class="tsd-kind-icon">uuid</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 tsd-is-overwrite tsd-is-protected"><a href="streamdeckpluginhandler.html#_eventhandler" class="tsd-kind-icon">_event<wbr>Handler</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#enabledebug" class="tsd-kind-icon">enable<wbr>Debug</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#logmessage" class="tsd-kind-icon">log<wbr>Message</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#openurl" class="tsd-kind-icon">open<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#requestglobalsettings" class="tsd-kind-icon">request<wbr>Global<wbr>Settings</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#requestsettings" class="tsd-kind-icon">request<wbr>Settings</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streamdeckpluginhandler.html#send" class="tsd-kind-icon">send</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckpluginhandler.html#sendtopropertyinspector" class="tsd-kind-icon">send<wbr>ToProperty<wbr>Inspector</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckpluginhandler.html#setfeedback" class="tsd-kind-icon">set<wbr>Feedback</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckpluginhandler.html#setfeedbacklayout" class="tsd-kind-icon">set<wbr>Feedback<wbr>Layout</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckpluginhandler.html#setimage" class="tsd-kind-icon">set<wbr>Image</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckpluginhandler.html#setimagefromurl" class="tsd-kind-icon">set<wbr>Image<wbr>From<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckpluginhandler.html#setstate" class="tsd-kind-icon">set<wbr>State</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckpluginhandler.html#settitle" class="tsd-kind-icon">set<wbr>Title</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckpluginhandler.html#showalert" class="tsd-kind-icon">show<wbr>Alert</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckpluginhandler.html#showok" class="tsd-kind-icon">show<wbr>Ok</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="streamdeckpluginhandler.html#switchtoprofile" class="tsd-kind-icon">switch<wbr>ToProfile</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite tsd-is-protected">
<a name="constructor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">new <wbr>Stream<wbr>Deck<wbr>Plugin<wbr>Handler<GlobalSettings><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="streamdeckpluginhandler.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckPluginHandler</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GlobalSettings</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-plugin-handler.ts#L15">abstracts/stream-deck-plugin-handler.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>GlobalSettings = <span class="tsd-signature-type">any</span></h4>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="streamdeckpluginhandler.html" class="tsd-signature-type" data-tsd-kind="Class">StreamDeckPluginHandler</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">GlobalSettings</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
<a name="actionmanager" class="tsd-anchor"></a>
<h3>action<wbr>Manager</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> actionManager<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="actionmanager.html" class="tsd-signature-type" data-tsd-kind="Class">ActionManager</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/abstracts/stream-deck-plugin-handler.ts#L22">abstracts/stream-deck-plugin-handler.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="actionmanager.html" class="tsd-signature-type" data-tsd-kind="Class">ActionManager</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="connectionready" class="tsd-anchor"></a>
<h3>connection<wbr>Ready</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> connectionReady<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/abstracts/stream-deck-handler-base.ts#L111">abstracts/stream-deck-handler-base.ts:111</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="documentready" class="tsd-anchor"></a>
<h3>document<wbr>Ready</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> documentReady<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/abstracts/stream-deck-handler-base.ts#L107">abstracts/stream-deck-handler-base.ts:107</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="globalsettingsready" class="tsd-anchor"></a>
<h3>global<wbr>Settings<wbr>Ready</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> globalSettingsReady<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/abstracts/stream-deck-handler-base.ts#L115">abstracts/stream-deck-handler-base.ts:115</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="info" class="tsd-anchor"></a>
<h3>info</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> info<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/initeventinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">InitEventInfo</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/abstracts/stream-deck-handler-base.ts#L94">abstracts/stream-deck-handler-base.ts:94</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>All the information send from Elgato</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/initeventinfo.html" class="tsd-signature-type" data-tsd-kind="Interface">InitEventInfo</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="port" class="tsd-anchor"></a>
<h3>port</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> port<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/abstracts/stream-deck-handler-base.ts#L71">abstracts/stream-deck-handler-base.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The port for the Stream Deck Application</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="registerevent" class="tsd-anchor"></a>
<h3>register<wbr>Event</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> registerEvent<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/abstracts/stream-deck-handler-base.ts#L86">abstracts/stream-deck-handler-base.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Event sent from Elgato, which is needed for the registration procedure</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="settingsmanager" class="tsd-anchor"></a>
<h3>settings<wbr>Manager</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> settingsManager<span class="tsd-signature-symbol">(</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/abstracts/stream-deck-handler-base.ts#L103">abstracts/stream-deck-handler-base.ts:103</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Through this object you can get, set and edit all available settings (global settings and context settings)</p>
</div>
<dl class="tsd-comment-tags">
<dt>see</dt>
<dd><p><a href="settingsmanager.html">SettingsManager</a></p>
</dd>
</dl>
</div>
<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 class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="uuid" class="tsd-anchor"></a>
<h3>uuid</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> uuid<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/abstracts/stream-deck-handler-base.ts#L78">abstracts/stream-deck-handler-base.ts:78</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>The UUID of the Plugin</p>
</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 tsd-is-overwrite tsd-is-protected">
<a name="_eventhandler" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _event<wbr>Handler</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">_event<wbr>Handler<span class="tsd-signature-symbol">(</span>ev<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MessageEvent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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">
<p>Overrides StreamDeckHandlerBase._eventHandler</p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-plugin-handler.ts#L187">abstracts/stream-deck-plugin-handler.ts:187</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>ev: <span class="tsd-signature-type">MessageEvent</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
</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-is-inherited">
<a name="enabledebug" class="tsd-anchor"></a>
<h3>enable<wbr>Debug</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">enable<wbr>Debug<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">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#enabledebug">enableDebug</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L207">abstracts/stream-deck-handler-base.ts:207</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Enables debug mode so you can see incoming and outgoing events.</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-is-inherited">
<a name="logmessage" class="tsd-anchor"></a>
<h3>log<wbr>Message</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">log<wbr>Message<span class="tsd-signature-symbol">(</span>message<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#logmessage">logMessage</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L177">abstracts/stream-deck-handler-base.ts:177</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Logs a message to the elgato log file</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>message: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</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-is-inherited">
<a name="openurl" class="tsd-anchor"></a>
<h3>open<wbr>Url</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">open<wbr>Url<span class="tsd-signature-symbol">(</span>url<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#openurl">openUrl</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L167">abstracts/stream-deck-handler-base.ts:167</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Opens a url</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</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-is-inherited">
<a name="requestglobalsettings" class="tsd-anchor"></a>
<h3>request<wbr>Global<wbr>Settings</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">request<wbr>Global<wbr>Settings<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">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#requestglobalsettings">requestGlobalSettings</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L157">abstracts/stream-deck-handler-base.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Requests global settings</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-is-inherited">
<a name="requestsettings" class="tsd-anchor"></a>
<h3>request<wbr>Settings</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">request<wbr>Settings<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#requestsettings">requestSettings</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L136">abstracts/stream-deck-handler-base.ts:136</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Requests settings for current context / action</p>
</div>
</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">
</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-is-inherited">
<a name="send" class="tsd-anchor"></a>
<h3>send</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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">
<p>Inherited from <a href="streamdeckhandlerbase.html">StreamDeckHandlerBase</a>.<a href="streamdeckhandlerbase.html#send">send</a></p>
<ul>
<li>Defined in <a href="https://github.com/XeroxDev/Stream-Deck-TS-SDK/blob/6b28bd9/src/abstracts/stream-deck-handler-base.ts#L188">abstracts/stream-deck-handler-base.ts:188</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sends custom socket events to the stream deck software</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>event: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>data: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
</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="sendtopropertyinspector" class="tsd-anchor"></a>
<h3>send<wbr>ToProperty<wbr>Inspector</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">send<wbr>ToProperty<wbr>Inspector<span class="tsd-signature-symbol">(</span>payload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, action<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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">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/abstracts/stream-deck-plugin-handler.ts#L175">abstracts/stream-deck-plugin-handler.ts:175</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Send data to the property inspector</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>payload: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Data to send</p>
</div>
</li>
<li>
<h5>action: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Action context.</p>
</div>
</li>
<li>
<h5>context: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The context which called it</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="setfeedback" class="tsd-anchor"></a>
<h3>set<wbr>Feedback</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Feedback<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, payload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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/abstracts/stream-deck-plugin-handler.ts#L248">abstracts/stream-deck-plugin-handler.ts:248</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the action title</p>
</div>
</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>The context which called it</p>
</div>
</li>
<li>
<h5>payload: <span class="tsd-signature-type">any</span></h5>
</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="setfeedbacklayout" class="tsd-anchor"></a>
<h3>set<wbr>Feedback<wbr>Layout</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Feedback<wbr>Layout<span class="tsd-signature-symbol">(</span>context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, layout<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">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/abstracts/stream-deck-plugin-handler.ts#L263">abstracts/stream-deck-plugin-handler.ts:263</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the action title</p>
</div>
</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>The context which called it</p>
</div>
</li>
<li>
<h5>layout: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
</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="setimage" class="tsd-anchor"></a>
<h3>set<wbr>Image</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Image<span class="tsd-signature-symbol">(</span>image<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, target<span class="tsd-signature-symbol">?: </span><a href="../enums/targettype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TargetType</a>, state<span class="tsd-signature-symbol">?: </span><a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a><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/abstracts/stream-deck-plugin-handler.ts#L59">abstracts/stream-deck-plugin-handler.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the action image</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>image: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Image as string</p>
</div>
</li>
<li>
<h5>context: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The context which called it</p>
</div>
</li>
<li>
<h5>target: <a href="../enums/targettype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TargetType</a><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>Show image only on hardware, software or both (default: Both)</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> state: <a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a></h5>
<div class="tsd-comment tsd-typography">
<p>Show image only on ON state or OFF state (default: Both)</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="setimagefromurl" class="tsd-anchor"></a>
<h3>set<wbr>Image<wbr>From<wbr>Url</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Image<wbr>From<wbr>Url<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, target<span class="tsd-signature-symbol">?: </span><a href="../enums/targettype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TargetType</a>, state<span class="tsd-signature-symbol">?: </span><a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></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/abstracts/stream-deck-plugin-handler.ts#L86">abstracts/stream-deck-plugin-handler.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the action image but instead from file, from URL</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>url: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>context: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>target: <a href="../enums/targettype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TargetType</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> state: <a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="setstate" class="tsd-anchor"></a>
<h3>set<wbr>State</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>State<span class="tsd-signature-symbol">(</span>state<span class="tsd-signature-symbol">: </span><a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a>, 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">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/abstracts/stream-deck-plugin-handler.ts#L149">abstracts/stream-deck-plugin-handler.ts:149</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the state of the action (ON / OFF)</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>state: <a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a></h5>
</li>
<li>
<h5>context: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The context which called it</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="settitle" class="tsd-anchor"></a>
<h3>set<wbr>Title</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Title<span class="tsd-signature-symbol">(</span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, context<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, target<span class="tsd-signature-symbol">?: </span><a href="../enums/targettype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TargetType</a>, state<span class="tsd-signature-symbol">?: </span><a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a><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/abstracts/stream-deck-plugin-handler.ts#L33">abstracts/stream-deck-plugin-handler.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sets the action title</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>title: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The string the title should be</p>
</div>
</li>
<li>
<h5>context: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The context which called it</p>
</div>
</li>
<li>
<h5>target: <a href="../enums/targettype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TargetType</a><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>Show title only on hardware, software or both (default: Both)</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> state: <a href="../enums/statetype.html" class="tsd-signature-type" data-tsd-kind="Enumeration">StateType</a></h5>
<div class="tsd-comment tsd-typography">
<p>Show title only on ON state or OFF state (default: Both)</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="showalert" class="tsd-anchor"></a>
<h3>show<wbr>Alert</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">show<wbr>Alert<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">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/abstracts/stream-deck-plugin-handle