@iotize/device-client.js
Version:
IoTize Device client for Javascript
183 lines (182 loc) • 5.59 kB
TypeScript
/**
* This file has been generated
* DO NOT EDIT, IT MAY BE OVERWRITTEN
*/
import { Client, Response, ApiConfig } from "../import-adapter";
import { AbstractService, ServiceCallType } from '../abstract-service';
import { DataLogOption } from '../../all-models';
import { SinglePacket } from '../../all-models';
export declare class DataLogService extends AbstractService {
constructor(client: Client, apiConfig: ApiConfig);
resources: {
[key: string]: ServiceCallType;
};
/**
* Dequeue one packet
* Dequeue one packet in the FIFO list (Firt In First Out) of data-log packets
* LWM2M path: /1031//11
* @tapVersion(">=1.0")
* @return SinglePacket api call
*/
dequeueOnePacket(): Promise<Response<SinglePacket>>;
/**
* Dequeue one packet
* Dequeue one packet in the FIFO list (Firt In First Out) of data-log packets
* LWM2M path: /1031//11
* @tapVersion(">=1.0")
* @return call options
*/
dequeueOnePacketCall(): ServiceCallType;
/**
* Flush data log packets
* Reinitialisation : efface tous les paquets de la mémoire de l'IoTize. Seulement en état Stop ? Stop implicite avant le flush ? Run implicite après le flush ?
* LWM2M path: /1031//4
* @tapVersion(">=1.0")
* @return void api call
*/
flush(): Promise<Response<void>>;
/**
* Flush data log packets
* Reinitialisation : efface tous les paquets de la mémoire de l'IoTize. Seulement en état Stop ? Stop implicite avant le flush ? Run implicite après le flush ?
* LWM2M path: /1031//4
* @tapVersion(">=1.0")
* @return call options
*/
flushCall(): ServiceCallType;
/**
* Get the maximum number of packet
*
* LWM2M path: /1024//23
* @tapVersion(">=1.0")
* @return number api call
*/
getMaxPacketCount(): Promise<Response<number>>;
/**
* Get the maximum number of packet
*
* LWM2M path: /1024//23
* @tapVersion(">=1.0")
* @return call options
*/
getMaxPacketCountCall(): ServiceCallType;
/**
* Get data log options
*
* LWM2M path: /1031//2
* @tapVersion(">=1.0")
* @return DataLogOption api call
*/
getOptions(): Promise<Response<DataLogOption>>;
/**
* Get data log options
*
* LWM2M path: /1031//2
* @tapVersion(">=1.0")
* @return call options
*/
getOptionsCall(): ServiceCallType;
/**
* Get number of pending data-log packet
* Get the number of data log packet available
* LWM2M path: /1031//10
* @tapVersion(">=1.0")
* @return number api call
*/
getPacketCount(): Promise<Response<number>>;
/**
* Get number of pending data-log packet
* Get the number of data log packet available
* LWM2M path: /1031//10
* @tapVersion(">=1.0")
* @return call options
*/
getPacketCountCall(): ServiceCallType;
/**
* Returns true is data log acquisition is running
*
* LWM2M path: /1031//0
* @tapVersion(">=1.0")
* @return boolean api call
*/
isRunning(): Promise<Response<boolean>>;
/**
* Returns true is data log acquisition is running
*
* LWM2M path: /1031//0
* @tapVersion(">=1.0")
* @return call options
*/
isRunningCall(): ServiceCallType;
/**
* Write data log crypto key
* Hash du password Dataloggin. Utilisé (combiné à d'autres choses) pour crypter le paquet avant de le stocker dans l'OutBox.
* LWM2M path: /1031//3
* Body converter id: "Bytes"
* @tapVersion(">=1.0")
* @param value input
* @return void api call
*/
putCryptoKey(value: Uint8Array): Promise<Response<void>>;
/**
* Write data log crypto key
* Hash du password Dataloggin. Utilisé (combiné à d'autres choses) pour crypter le paquet avant de le stocker dans l'OutBox.
* LWM2M path: /1031//3
* Body converter id: "Bytes"
* @tapVersion(">=1.0")
* @param value input
* @return call options
*/
putCryptoKeyCall(value: Uint8Array): ServiceCallType;
/**
* Write data log option
*
* LWM2M path: /1031//2
* Body converter id: "DataLogOption"
* @tapVersion(">=1.0")
* @param value input
* @return void api call
*/
putOptions(value: DataLogOption): Promise<Response<void>>;
/**
* Write data log option
*
* LWM2M path: /1031//2
* Body converter id: "DataLogOption"
* @tapVersion(">=1.0")
* @param value input
* @return call options
*/
putOptionsCall(value: DataLogOption): ServiceCallType;
/**
* Run data-log acquisition
* Start data log packet acquisition
* LWM2M path: /1031//0
* @tapVersion(">=1.0")
* @return void api call
*/
run(): Promise<Response<void>>;
/**
* Run data-log acquisition
* Start data log packet acquisition
* LWM2M path: /1031//0
* @tapVersion(">=1.0")
* @return call options
*/
runCall(): ServiceCallType;
/**
* Stop data-log acquisition
* Stop data log packet acquisition
* LWM2M path: /1031//1
* @tapVersion(">=1.0")
* @return void api call
*/
stop(): Promise<Response<void>>;
/**
* Stop data-log acquisition
* Stop data log packet acquisition
* LWM2M path: /1031//1
* @tapVersion(">=1.0")
* @return call options
*/
stopCall(): ServiceCallType;
}