@iotize/tap/service/impl/data-log/lib/generated/service.d.ts

IoTize Device client for Javascript

/**
 *   Generated file. Do not edit
 */
import { TapResponse } from '@iotize/tap';
import { DataLogOption } from './models';
import { SinglePacket } from '@iotize/tap/service/impl/single-packet';
import { AbstractService, ServiceCallType } from '@iotize/tap';
export declare class DataLogService extends AbstractService {
    resources: {
        getMaxPacketCount: ServiceCallType<void, number>;
        isRunning: ServiceCallType<void, boolean>;
        run: ServiceCallType<void, void>;
        stop: ServiceCallType<void, void>;
        getOptions: ServiceCallType<void, DataLogOption>;
        putOptions: ServiceCallType<DataLogOption, void>;
        putCryptoKey: ServiceCallType<Uint8Array, void>;
        flush: ServiceCallType<void, void>;
        getPacketCount: ServiceCallType<void, number>;
        dequeueOnePacket: ServiceCallType<void, SinglePacket>;
    };
    /**
     * Get the maximum number of packet
     *
     * LWM2M path: /1024//23
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getMaxPacketCount(): Promise<TapResponse<number>>;
    /**
     *
     *
     * LWM2M path: /1024//23
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getMaxPacketCountCall(): ServiceCallType;
    /**
     * Get datalog running status
     *
     * LWM2M path: /1031//0
     *
     * @tapVersion(">=1.0")
     * @return
     */
    isRunning(): Promise<TapResponse<boolean>>;
    /**
     *
     *
     * LWM2M path: /1031//0
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    isRunningCall(): ServiceCallType;
    /**
     * Run data-log acquisition
     *
     * LWM2M path: /1031//0
     *
     * @tapVersion(">=1.0")
     * @return
     */
    run(): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1031//0
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    runCall(): ServiceCallType;
    /**
     * Stop data-log acquisition
     *
     * LWM2M path: /1031//1
     *
     * @tapVersion(">=1.0")
     * @return
     */
    stop(): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1031//1
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    stopCall(): ServiceCallType;
    /**
     * Get data log options
     *
     * LWM2M path: /1031//2
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getOptions(): Promise<TapResponse<DataLogOption>>;
    /**
     *
     *
     * LWM2M path: /1031//2
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getOptionsCall(): ServiceCallType;
    /**
     * Write data log option
     *
     * LWM2M path: /1031//2
     *
     * @tapVersion(">=1.0")
     * @param value input
     * @return
     */
    putOptions(value: DataLogOption): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1031//2
     *
     * @tapVersion(">=1.0")
     * @param value input
     * @return call options
     */
    putOptionsCall(value: DataLogOption): ServiceCallType;
    /**
     * Write data log crypto key
     *
     * LWM2M path: /1031//3
     *
     * @tapVersion(">=1.0")
     * @param value input
     * @return
     */
    putCryptoKey(value: Uint8Array): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1031//3
     *
     * @tapVersion(">=1.0")
     * @param value input
     * @return call options
     */
    putCryptoKeyCall(value: Uint8Array): ServiceCallType;
    /**
     * Flush data log packets
     *
     * LWM2M path: /1031//4
     *
     * @tapVersion(">=1.0")
     * @return
     */
    flush(): Promise<TapResponse<void>>;
    /**
     *
     *
     * LWM2M path: /1031//4
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    flushCall(): ServiceCallType;
    /**
     * Get number of pending data-log packet
     *
     * LWM2M path: /1031//10
     *
     * @tapVersion(">=1.0")
     * @return
     */
    getPacketCount(): Promise<TapResponse<number>>;
    /**
     *
     *
     * LWM2M path: /1031//10
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    getPacketCountCall(): ServiceCallType;
    /**
     * Dequeue one packet
     *
     * LWM2M path: /1031//11
     *
     * @tapVersion(">=1.0")
     * @return
     */
    dequeueOnePacket(): Promise<TapResponse<SinglePacket>>;
    /**
     *
     *
     * LWM2M path: /1031//11
     *
     * @tapVersion(">=1.0")
     * @return call options
     */
    dequeueOnePacketCall(): ServiceCallType;
}