Package com.kii.cloud.storage

Class MqttMessage.Builder

java.lang.Object

com.kii.cloud.storage.MqttMessage.Builder

Enclosing class:

MqttMessage

public static class MqttMessage.Builder
extends java.lang.Object

Builder of MqttMessage.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MqttMessage.Builder.MqttData	Represent data to be delivered to Mqtt device.

Method Summary

Modifier and Type	Method	Description
MqttMessage	build()	Build and return MqttMessage.
MqttMessage.Builder	dryRun(boolean dryRun)	Used for testing.
MqttMessage.Builder	enable(boolean enabled)	Set flag of MqttMessage delivery.
MqttMessage.Builder	qos(int qos)	Quality of service for the message (default will be 0 - fire and forget)
MqttMessage.Builder	retain(boolean retain)	Retain message.
MqttMessage.Builder	withMqttData(MqttMessage.Builder.MqttData data)	Create builder with Data that will be sent only to Mqtt devices.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

@NonNull
public MqttMessage build()

Build and return MqttMessage.

enable

@NonNull
public MqttMessage.Builder enable(boolean enabled)

Set flag of MqttMessage delivery. If omit calling this method, MqttMessage delivery is enabled. If KiiPushMessage.Builder.enableMqtt(boolean) called after KiiPushMessage.Builder.withMqttMessage(MqttMessage), This property would be overwritten. (The converse also overwrite the property.)

Parameters:

enabled - if true message would be delivered via Mqtt. If false, this message would not delivered thru Mqtt.

Returns:

Builder of the message

dryRun

@NonNull
public MqttMessage.Builder dryRun(boolean dryRun)

Used for testing. If provided with "true" value, the message will not be sent to the device. Default is "false".

Parameters:

dryRun -

Returns:

retain

@NonNull
public MqttMessage.Builder retain(boolean retain)

Retain message.

Parameters:

retain -

Returns:

qos

@NonNull
public MqttMessage.Builder qos(int qos)

Quality of service for the message (default will be 0 - fire and forget)

Parameters:

qos -

Returns:

withMqttData

@NonNull
public MqttMessage.Builder withMqttData(@Nullable
                                        MqttMessage.Builder.MqttData data)

Create builder with Data that will be sent only to Mqtt devices. Corresponding to JPush's custom payload.

Parameters:

data - KiiPushMessage.Data Mqtt specific data.