<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>MqttWill | @vertx/vertx-mqtt</title>
	<meta name="description" content="Documentation for @vertx/vertx-mqtt">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
</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">@vertx/vertx-mqtt</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-only-exported" />
							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
				</li>
				<li>
					<a href="mqttwill.html">MqttWill</a>
				</li>
			</ul>
			<h1>Class MqttWill</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>Will information from the remote MQTT client</p>
					</div>
				</div>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">MqttWill</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="mqttwill.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="mqttwill.html#getwillmessage" class="tsd-kind-icon">get<wbr>Will<wbr>Message</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mqttwill.html#getwillmessagebytes" class="tsd-kind-icon">get<wbr>Will<wbr>Message<wbr>Bytes</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mqttwill.html#getwillqos" class="tsd-kind-icon">get<wbr>Will<wbr>Qos</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mqttwill.html#getwilltopic" class="tsd-kind-icon">get<wbr>Will<wbr>Topic</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mqttwill.html#iswillflag" class="tsd-kind-icon">is<wbr>Will<wbr>Flag</a></li>
								<li class="tsd-kind-method tsd-parent-kind-class"><a href="mqttwill.html#iswillretain" class="tsd-kind-icon">is<wbr>Will<wbr>Retain</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>Mqtt<wbr>Will<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="mqttwill.html" class="tsd-signature-type">MqttWill</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mqttwill.html" class="tsd-signature-type">MqttWill</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:591</li>
								</ul>
							</aside>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>obj: <a href="mqttwill.html" class="tsd-signature-type">MqttWill</a></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="mqttwill.html" class="tsd-signature-type">MqttWill</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="getwillmessage" class="tsd-anchor"></a>
					<h3>get<wbr>Will<wbr>Message</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Will<wbr>Message<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 options.d.ts:601</li>
								</ul>
							</aside>
							<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-method tsd-parent-kind-class">
					<a name="getwillmessagebytes" class="tsd-anchor"></a>
					<h3>get<wbr>Will<wbr>Message<wbr>Bytes</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Will<wbr>Message<wbr>Bytes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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 options.d.ts:605</li>
								</ul>
							</aside>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</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="getwillqos" class="tsd-anchor"></a>
					<h3>get<wbr>Will<wbr>Qos</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Will<wbr>Qos<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in options.d.ts:609</li>
								</ul>
							</aside>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
					<a name="getwilltopic" class="tsd-anchor"></a>
					<h3>get<wbr>Will<wbr>Topic</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">get<wbr>Will<wbr>Topic<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 options.d.ts:617</li>
								</ul>
							</aside>
							<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-method tsd-parent-kind-class">
					<a name="iswillflag" class="tsd-anchor"></a>
					<h3>is<wbr>Will<wbr>Flag</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">is<wbr>Will<wbr>Flag<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 options.d.ts:597</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-method tsd-parent-kind-class">
					<a name="iswillretain" class="tsd-anchor"></a>
					<h3>is<wbr>Will<wbr>Retain</h3>
					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
						<li class="tsd-signature tsd-kind-icon">is<wbr>Will<wbr>Retain<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 options.d.ts:613</li>
								</ul>
							</aside>
							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</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="globals  ">
						<a href="../globals.html"><em>Globals</em></a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-class">
						<a href="mqttauth.html" class="tsd-kind-icon">Mqtt<wbr>Auth</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mqttclient.html" class="tsd-kind-icon">Mqtt<wbr>Client</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mqttclientoptions.html" class="tsd-kind-icon">Mqtt<wbr>Client<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mqttconnackmessage.html" class="tsd-kind-icon">Mqtt<wbr>Conn<wbr>Ack<wbr>Message</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mqttendpoint.html" class="tsd-kind-icon">Mqtt<wbr>Endpoint</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mqttpublishmessage.html" class="tsd-kind-icon">Mqtt<wbr>Publish<wbr>Message</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mqttserver.html" class="tsd-kind-icon">Mqtt<wbr>Server</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mqttserveroptions.html" class="tsd-kind-icon">Mqtt<wbr>Server<wbr>Options</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mqttsubackmessage.html" class="tsd-kind-icon">Mqtt<wbr>Sub<wbr>Ack<wbr>Message</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mqttsubscribemessage.html" class="tsd-kind-icon">Mqtt<wbr>Subscribe<wbr>Message</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mqtttopicsubscription.html" class="tsd-kind-icon">Mqtt<wbr>Topic<wbr>Subscription</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="mqttunsubscribemessage.html" class="tsd-kind-icon">Mqtt<wbr>Unsubscribe<wbr>Message</a>
					</li>
				</ul>
				<ul class="current">
					<li class="current tsd-kind-class">
						<a href="mqttwill.html" class="tsd-kind-icon">Mqtt<wbr>Will</a>
						<ul>
							<li class=" tsd-kind-constructor tsd-parent-kind-class">
								<a href="mqttwill.html#constructor" class="tsd-kind-icon">constructor</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mqttwill.html#getwillmessage" class="tsd-kind-icon">get<wbr>Will<wbr>Message</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mqttwill.html#getwillmessagebytes" class="tsd-kind-icon">get<wbr>Will<wbr>Message<wbr>Bytes</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mqttwill.html#getwillqos" class="tsd-kind-icon">get<wbr>Will<wbr>Qos</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mqttwill.html#getwilltopic" class="tsd-kind-icon">get<wbr>Will<wbr>Topic</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mqttwill.html#iswillflag" class="tsd-kind-icon">is<wbr>Will<wbr>Flag</a>
							</li>
							<li class=" tsd-kind-method tsd-parent-kind-class">
								<a href="mqttwill.html#iswillretain" class="tsd-kind-icon">is<wbr>Will<wbr>Retain</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
					<li class=" tsd-kind-interface">
						<a href="../interfaces/mqttmessage.html" class="tsd-kind-icon">Mqtt<wbr>Message</a>
					</li>
				</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>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static 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>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>