@mindconnect/mindconnect-nodejs
Version:
NodeJS Library for Siemens Insights Hub Connectivity - TypeScript SDK for Insights Hub and Industrial IoT - Command Line Interface - Insights Hub Development Proxy (Siemens Insights Hub was formerly known as MindSphere)
69 lines (68 loc) • 2.47 kB
TypeScript
import { DiagnosticInformation, OnlineStatus, PagedDiagnosticActivation, PagedDiagnosticInformation } from "..";
import { CredentialAuth } from "./credential-auth";
import { OnboardingStatus } from "./mindconnect-models";
/**
* @deprecated replaced with MindSphereSDK
*
* This class is deprecated. please use MinSphereSDK for this
*
* @export
* @class MindConnectSetup
*/
export declare class MindConnectSetup extends CredentialAuth {
/**
* Register the agent for diagnostics.
*
* @param {string} agentId
* @returns
*
* @memberOf MindConnectSetup
*/
RegisterForDiagnostic(agentId: string): Promise<any>;
/**
* @deprecated replaced with MindSphereSDK
*
* @param {string} agentId
* @param {boolean} [ignoreError=false]
* @returns
*
* @memberOf MindConnectSetup
*/
DeleteDiagnostic(agentId: string, ignoreError?: boolean): Promise<true | undefined>;
private DeleteActivation;
/**
* @deprecated replaced with MindSphereSDK
*
* Delete all diagnostic activations. As there are only 5 global diagnostic activations this can have unintended consequences.
* Use with care.
*
* @memberOf MindConnectSetup
*/
DeleteAllDiagnosticActivations(): Promise<void>;
/**
* @deprecated replaced with MindSphereSDK
*
* Gets all registered agents for diagnostic.
*
* @returns {Promise<PagedDiagnosticActivation>}
*
* @memberOf MindConnectSetup
*/
GetDiagnosticActivations(): Promise<PagedDiagnosticActivation>;
/**
* @deprecated replaced with MindSphereSDK
*
* Gets the diagnostic information for the registered agent(s)
*
* @param {string} [agentId] - Optional: If passed, only logs for this agent will be retrieved.
* @param {(x: DiagnosticInformation[], ...args: any[]) => any} [callback] - Optional: pass the function which will handle the paged diagnostic info. The CLI uses printing to console function
* @param {*} [callbackOptions]
* @returns
*
* @memberOf MindConnectSetup
*/
GetDiagnosticInformation(agentId?: string, callback?: (x: DiagnosticInformation[], ...args: any[]) => any, callbackOptions?: any, skipToLast?: boolean): Promise<PagedDiagnosticInformation>;
private GetPagedInforamtion;
GetAgentStatus(agentId: string): Promise<OnlineStatus>;
GetBoardingStatus(agentId: string): Promise<OnboardingStatus>;
}