@ctodev/cclibrary-typings
Version:
Library typings for use with CLARC INFINITY
53 lines (52 loc) • 2.11 kB
TypeScript
import { TccClientClassBase } from "./tcc-client-class-base";
export declare class TccClientScript extends TccClientClassBase {
/**
* Name bzw. Application-Tag der Anwendung die das Script ausführt.
*/
get Application(): string;
/**
* Gibt an, ob das Script in einem Service oder in einem Applikationskontext läuft.
*/
get AsService(): boolean;
/**
* Gibt die Version der eingesetzten Scriptengine zurück.
* Die Funktion kann beispielsweise für versionsabhängige Bedingungen verwendet werden.
*/
get EngineVersion(): string;
/**
* Gibt Instanz-Nummer (0~n) der eigenen Service-Instanz (0 = Masterinstanz, jede weitere + 1) z.B. beim WARP an.
*/
get InstanceId(): number;
/**
* Gibt Laufzeit-Id des aktuellen Services an. Der InstanceToken ~ 32 stellige GUID.
*/
get InstanceToken(): string;
/**
* Info beinhaltet den am Script definierten Beschreibungstext zum derzeit ausgeführten Script.
*/
get ScriptInfo(): string;
/**
* Name des derzeit ausgeführten Scripts.
*/
get ScriptName(): string;
/**
* Log
* Die Log Funktion erstellt einen Logeintrag im entsprechenden Logfile des Services.
* LogValue ist vom Typ Variant und beinhaltet den im Logfile auszugebenden Inhalt. Der Inhalt ist dabei beliebig.
* @param {any} LogType - LogType
* @param {string} LogValue - Log nachricht
* @returns {boolean} - success
*/
Log(LogType: any, LogValue: string): boolean;
/**
* VerifyLicense
* Prüft die angegebene Lizenz gegen den CLARC LICENSE Daemon und gibt den Lizenznehmer oder ggf. eine Fehlernachricht zurück.
* @param {string} User - Benutzername
* @param {string} Module - lizenziertes Modul
* @param {string} Version - Version
* @param {boolean} Register - Lizenz registrieren
* @param {boolean} Fast - Schnellverfahren
* @returns {boolean} - Lizenz verified
*/
VerifyLicense(User: string, Module: string, Version: string, Register: boolean, Fast: boolean): boolean;
}