@iotize/tap/service/impl/mqtt/lib/generated/service.d.ts

IoTize Device client for Javascript

/**
 *   Generated file. Do not edit
 */
import { TapResponse } from '@iotize/tap';
import { AbstractService, ServiceCallType } from '@iotize/tap';
export declare class MqttService extends AbstractService {
    resources: {
        getClientId: ServiceCallType<void, string>;
        putClientId: ServiceCallType<string, void>;
        getUsername: ServiceCallType<void, string>;
        putUsername: ServiceCallType<string, void>;
        getBrokerHostname: ServiceCallType<void, string>;
        putBrokerHostname: ServiceCallType<string, void>;
        getBrokerPort: ServiceCallType<void, string>;
        putBrokerPort: ServiceCallType<string, void>;
        getPassword: ServiceCallType<void, string>;
        putPassword: ServiceCallType<string, void>;
        getRelayNetKey: ServiceCallType<void, string>;
        putRelayNetKey: ServiceCallType<string, void>;
        putBrokerCertificate: ServiceCallType<Uint8Array, void>;
        getTopicPrefix: ServiceCallType<void, string>;
        putTopicPrefix: ServiceCallType<string, void>;
        getRequestTopic: ServiceCallType<void, string>;
        putRequestTopic: ServiceCallType<string, void>;
        getResponseTopic: ServiceCallType<void, string>;
        putResponseTopic: ServiceCallType<string, void>;
    };
    /**
     * Get mqtt relay client id
     *
     * LWM2M path: /1024//52
     *
     * @tapVersion(">=1.86")
     * @return
     */
    getClientId(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//52
     *
     * @tapVersion(">=1.86")
     * @return call options
     */
    getClientIdCall(): ServiceCallType;
    /**
     * Set mqtt relay client id
     *
     * LWM2M path: /1024//52
     *
     * @tapVersion(">=1.86")
     * @param url input
     * @return
     */
    putClientId(url: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//52
     *
     * @tapVersion(">=1.86")
     * @param url input
     * @return call options
     */
    putClientIdCall(url: string): ServiceCallType;
    /**
     * Get mqtt relay login. For firmware version <= 1.86, use serial number (resource /3//2)
     *
     * LWM2M path: /1024//53
     *
     * @deprecated
     * @tapVersion(">=1.86")
     * @return
     */
    getUsername(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//53
     *
     * @deprecated
     * @tapVersion(">=1.86")
     * @return call options
     */
    getUsernameCall(): ServiceCallType;
    /**
     * Write mqtt relay password id. For firmware version <= 1.86, use serial number (resource /3//2)
     *
     * LWM2M path: /1024//53
     *
     * @tapVersion(">=1.86")
     * @param url input
     * @return
     */
    putUsername(url: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//53
     *
     * @tapVersion(">=1.86")
     * @param url input
     * @return call options
     */
    putUsernameCall(url: string): ServiceCallType;
    /**
     * Get mqtt broker hostname
     *
     * LWM2M path: /1024//50
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getBrokerHostname(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//50
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getBrokerHostnameCall(): ServiceCallType;
    /**
     * Write mqtt relay host
     *
     * LWM2M path: /1024//50
     *
     * @tapVersion(">=1.0")
     * @param url input
     * @return
     */
    putBrokerHostname(url: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//50
     *
     * @tapVersion(">=1.0")
     * @param url input
     * @return call options
     */
    putBrokerHostnameCall(url: string): ServiceCallType;
    /**
     * Get port of the mqtt broker
     *
     * LWM2M path: /1024//51
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getBrokerPort(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//51
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getBrokerPortCall(): ServiceCallType;
    /**
     * Write service name of the mqtt broker
     *
     * LWM2M path: /1024//51
     *
     * @tapVersion(">=1.0")
     * @param url input
     * @return
     */
    putBrokerPort(url: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//51
     *
     * @tapVersion(">=1.0")
     * @param url input
     * @return call options
     */
    putBrokerPortCall(url: string): ServiceCallType;
    /**
     * Get the mqtt broker password
     *
     * LWM2M path: /1024//54
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getPassword(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//54
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getPasswordCall(): ServiceCallType;
    /**
     * Write mqtt broker password
     *
     * LWM2M path: /1024//54
     *
     * @tapVersion(">=1.0")
     * @param url input
     * @return
     */
    putPassword(url: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//54
     *
     * @tapVersion(">=1.0")
     * @param url input
     * @return call options
     */
    putPasswordCall(url: string): ServiceCallType;
    /**
     * Get the mqtt relay net key
     *
     * LWM2M path: /1024//55
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getRelayNetKey(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//55
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getRelayNetKeyCall(): ServiceCallType;
    /**
     * Write mqtt relay net key
     *
     * LWM2M path: /1024//55
     *
     * @tapVersion(">=1.0")
     * @param netkey input
     * @return
     */
    putRelayNetKey(netkey: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//55
     *
     * @tapVersion(">=1.0")
     * @param netkey input
     * @return call options
     */
    putRelayNetKeyCall(netkey: string): ServiceCallType;
    /**
     * Set MQTT broker certificate data
     *
     * LWM2M path: /1024//57
     *
     * @tapVersion(">=1.86")
     * @param value input
     * @return
     */
    putBrokerCertificate(value: Uint8Array): Promise<TapResponse<void>>;
    putBrokerCertificateAppendCalls(value: Uint8Array, chunkSize?: number): ServiceCallType<Uint8Array, void>[];
    /**
     *
     *
     * LWM2M path: /1024//57
     *
     * @tapVersion(">=1.86")
     * @param value input
     * @return call options
     */
    putBrokerCertificateCall(value: Uint8Array): ServiceCallType;
    /**
     * Get MQTT relay topic prefix
     *
     * LWM2M path: /1024//58
     *
     * @tapVersion(">=1.86")
     * @return
     */
    getTopicPrefix(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//58
     *
     * @tapVersion(">=1.86")
     * @return call options
     */
    getTopicPrefixCall(): ServiceCallType;
    /**
     * Put MQTT relay topic prefix
     *
     * LWM2M path: /1024//58
     *
     * @tapVersion(">=1.86")
     * @param topicPrefix input
     * @return
     */
    putTopicPrefix(topicPrefix: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//58
     *
     * @tapVersion(">=1.86")
     * @param topicPrefix input
     * @return call options
     */
    putTopicPrefixCall(topicPrefix: string): ServiceCallType;
    /**
     * Get mqtt request topic
     *
     * LWM2M path: /1024//58
     *
     * @tapVersion(">=1.86")
     * @return
     */
    getRequestTopic(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//58
     *
     * @tapVersion(">=1.86")
     * @return call options
     */
    getRequestTopicCall(): ServiceCallType;
    /**
     * Put mqtt request topic
     *
     * LWM2M path: /1024//58
     *
     * @tapVersion(">=1.86")
     * @param topic input
     * @return
     */
    putRequestTopic(topic: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//58
     *
     * @tapVersion(">=1.86")
     * @param topic input
     * @return call options
     */
    putRequestTopicCall(topic: string): ServiceCallType;
    /**
     * Get MQTT response topic
     *
     * LWM2M path: /1024//59
     *
     * @tapVersion(">=1.107")
     * @return
     */
    getResponseTopic(): Promise<TapResponse<string>>;
    /**
     *
     *
     * LWM2M path: /1024//59
     *
     * @tapVersion(">=1.107")
     * @return call options
     */
    getResponseTopicCall(): ServiceCallType;
    /**
     * Put MQTT response topic
     *
     * LWM2M path: /1024//59
     *
     * @tapVersion(">=1.107")
     * @param topic input
     * @return
     */
    putResponseTopic(topic: string): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1024//59
     *
     * @tapVersion(">=1.107")
     * @param topic input
     * @return call options
     */
    putResponseTopicCall(topic: string): ServiceCallType;
}