# Class: MqttWill

## vertx-mqtt-server-js/mqtt_will~ MqttWill

#### new MqttWill()

Will information from the remote MQTT client

Source:
  - vertx-mqtt-server-js/mqtt_will.js, line 29

### Methods

#### isWillFlag() → {boolean}

Source:
  - vertx-mqtt-server-js/mqtt_will.js, line 40

##### Returns:

the will flag for indicating the will message presence

Type
  boolean

#### isWillRetain() → {boolean}

Source:
  - vertx-mqtt-server-js/mqtt_will.js, line 104

##### Returns:

true if the will must be retained as provided by the remote MQTT client

Type
  boolean

#### willMessage() → {string}

Source:
  - vertx-mqtt-server-js/mqtt_will.js, line 72

##### Returns:

the payload for the will as provided by the remote MQTT client

Type
  string

#### willQos() → {number}

Source:
  - vertx-mqtt-server-js/mqtt_will.js, line 88

##### Returns:

the QoS level for the will as provided by the remote MQTT client

Type
  number

#### willTopic() → {string}

Source:
  - vertx-mqtt-server-js/mqtt_will.js, line 56

##### Returns:

the topic for the will as provided by the remote MQTT client

Type
  string