SDK-Funktionen und Rückgaben in neun Sprachen
Öffentliche Launch-Funktionen, Parameter, Rückgaben und Fehler nach Sprache. Optionale Parameter und Standardwerte richten sich nach der passenden Quellversion.
Diese Seite beschreibt die Launch-Kontoadapter. Autorisierungs-, Verbrauchs- und Offline-APIs von Licentivo stehen in der offiziellen SDK-Referenz.
Licentivo SDK · Funktionsreferenz
Der Sitzungsstatus beschreibt nur das Konto; jede geschützte Geschäftsausführung prüfen.
Standardmäßig wird Arbeitsspeicher verwendet. Gespeicherte Anmeldungen brauchen geschützten Dauerspeicher, getrennt vom SDK-Cache.
Wiederherstellung benötigt Online-Kontobestätigung. Launch wählt bei Netzfehlern keine Offline-Rechte; diese prüft das offizielle SDK.
Go
Zugehöriger Quellcode · v0.1.6 · application.go · runtime.go · client.go · store.go
Fehlerbehandlung: error != nil; errors.Is(err, launchclient.ErrNoSession); errors.As(err, &apiError)
Connect
Connect(merchantOrigin, productID, licentivoProductID string, trustedKeys map[string]string, options Config) → (*Application, error)- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
merchantOrigin / origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productID / product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.licentivoProductID / licentivo_product_id: Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen.trustedKeys / trusted_keys: Zuordnung von Signaturschlüsselkennungen zu öffentlichen Schlüsseln zur Prüfung signierter SDK-Rechte.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
(*Application, error)Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application.Login
Login(ctx context.Context, email, password string) → (State, error)- Zweck
- Meldet das Kundenkonto an, holt eine kurzlebige Identitätsbestätigung und startet das offizielle Autorisierungs-SDK.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.email, password: E-Mail und Passwort des Shop-Kundenkontos; Passwort nur für diese Anmeldung verwenden.
- Rückgabe
(State, error)Liefert den Kontostatus; Feldbedeutungen stehen in der folgenden Tabelle.
Application.Restore
Restore(ctx context.Context) → (State, error)- Zweck
- Liest die gespeicherte Sitzung, bestätigt das Konto online, holt eine neue Identitätsbestätigung und startet das offizielle SDK.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
(State, error)Liefert den Kontostatus; ErrNoSession oder NO_SESSION bedeutet keine gespeicherte Sitzung. Andere Fehler gesondert behandeln.
Application.RunFeature
RunFeature(feature string, action func() error) → error- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
errorKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application.Logout
Logout(ctx context.Context) → error- Zweck
- Beendet lokale Autorisierung, meldet das offizielle SDK ab und widerruft die Launch-Sitzung. Offene Fernaufgaben bleiben zur Wiederholung erhalten.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
errorKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application.ReleaseDevice
ReleaseDevice(ctx context.Context) → error- Zweck
- Kompatibilitätseinstieg zur ausdrücklichen Abmeldung mit demselben Konto- und Geräteablauf wie Logout.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
errorKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application.Close
Close() → void- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
voidKein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Erweiterte und Kompatibilitäts-APIs
NewApplication
NewApplication(config Config) → (*Application, error)- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
(*Application, error)Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
NewApplicationFromFiles
NewApplicationFromFiles(launchPath, productPath string, options Config) → (*Application, error)- Zweck
- Liest zwei vorhandene öffentliche Konfigurationen, prüft die Produktzuordnung und erstellt die Anwendung. Direktverbindungen benötigen keine Dateien.
- Parameter
launchPath, productPath: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
(*Application, error)Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
LoadPublicConfig
LoadPublicConfig(path string) → (PublicConfig, error)- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
path: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
(PublicConfig, error)Liefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
NewRuntime
NewRuntime(product ProductConfig, runtime RuntimeConfig) → (Runtime, error)- Zweck
- Erstellt den offiziellen SDK-Adapter für erweiterte Integrationen; die Identitätsbestätigung bleibt im Speicher.
- Parameter
product, runtime: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
(Runtime, error)Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
New
New(origin string, allowLocalHTTP bool) → (*Client, error)- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.allowLocalHTTP: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
(*Client, error)Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Client.WithToken
WithToken(token string) → *Client- Zweck
- Liefert eine Clientkopie mit dem angegebenen Kontotoken für vertrauenswürdige Backends.
- Parameter
token: Launch-Sitzungstoken, nur von Basissitzungs- oder verschlüsselten Speicherschnittstellen geliefert.
- Rückgabe
*ClientLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Client.Login
Login(ctx context.Context, email, password string) → (User, error)- Zweck
- Authentifiziert das Konto und liefert Kontodaten oder Sitzung, ohne Autorisierungslaufzeit zu starten.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.email, password: E-Mail und Passwort des Shop-Kundenkontos; Passwort nur für diese Anmeldung verwenden.
- Rückgabe
(User, error)Liefert den Kontostatus; Feldbedeutungen stehen in der folgenden Tabelle.
Client.LoginSession
LoginSession(ctx context.Context, email, password string) → (Session, error)- Zweck
- Authentifiziert das Konto und liefert Kontodaten oder Sitzung, ohne Autorisierungslaufzeit zu starten.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.email, password: E-Mail und Passwort des Shop-Kundenkontos; Passwort nur für diese Anmeldung verwenden.
- Rückgabe
(Session, error)Liefert den Kontostatus; Feldbedeutungen stehen in der folgenden Tabelle.
Client.CurrentUser
CurrentUser(ctx context.Context) → (User, error)- Zweck
- Fragt das aktuelle Konto ab; Erfolg erlaubt keine geschützten Funktionen.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
(User, error)Liefert den Kontostatus; Feldbedeutungen stehen in der folgenden Tabelle.
Client.Identity
Identity(ctx context.Context, product, environment string) → (Identity, error)- Zweck
- Holt eine einmalige Identitätsbestätigung und öffentliche Routingdaten; weder Lizenz noch Funktionsberechtigung.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.product: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.
- Rückgabe
(Identity, error)Liefert den Kontostatus; Feldbedeutungen stehen in der folgenden Tabelle.
Client.SignOut
SignOut(ctx context.Context) → error- Zweck
- Widerruft die Launch-Sitzung und löscht das Clienttoken; ersetzt keine Geräteabmeldung des offiziellen SDK.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
errorKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Client.Credential
Credential(ctx context.Context, product, environment string) → (Credential, error)- Zweck
- Beibehaltene Alt-API: Das Protokoll langfristiger Lizenzzugangsdaten wurde entfernt, daher schlagen Aufrufe fehl. Verwenden Sie Application.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.product: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.
- Rückgabe
(Credential, error)Schlägt immer fehl; auf Kontoidentitätsaustausch umstellen.
Client.CredentialWithRetry
CredentialWithRetry(ctx context.Context, product, environment string, policy RetryPolicy) → (Credential, error)- Zweck
- Beibehaltene Alt-API: Das Protokoll langfristiger Lizenzzugangsdaten wurde entfernt, daher schlagen Aufrufe fehl. Verwenden Sie Application.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.product: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.policy: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
(Credential, error)Schlägt immer fehl; auf Kontoidentitätsaustausch umstellen.
NewSystemSessionStore
NewSystemSessionStore(directory string) → (SessionStore, error)- Zweck
- Erstellt geschützten dauerhaften Sitzungsspeicher; der Schlüssel stammt aus dem Anmeldedatentresor des Betriebssystems.
- Parameter
directory: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
(SessionStore, error)Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
ProtectDirectory
ProtectDirectory(directory string) → error- Zweck
- Beschränkt Verzeichniszugriff auf den aktuellen Windows-Benutzer beziehungsweise private Rechte anderer Plattformen.
- Parameter
directory: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
errorKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
ServiceUnavailable
ServiceUnavailable(err error) → bool- Zweck
- Erkennt vorübergehende Nichtverfügbarkeit; dies erlaubt niemals Offline-Autorisierung.
- Parameter
err: Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Rückgabe
boolLiefert eine boolesche Klassifikation, keine Autorisierung.
APIError.Error / TransportError.Error
Error() → string- Zweck
- Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Rückgabe
stringLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
TransportError.Unwrap
Unwrap() → error- Zweck
- Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Rückgabe
errorLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
MemoryStore.Load / SessionStore.Load
Load(ctx context.Context, key string) → ([]byte, error)- Zweck
- Lädt den Kontodatensatz per isoliertem Schlüssel; geheime Inhalte gehören ausschließlich ins SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
([]byte, error)Liefert den geheimen Datensatz; bei Fehlen folgen ein leerer Wert oder ErrNoSession gemäß Sprachvertrag.
MemoryStore.Save / SessionStore.Save
Save(ctx context.Context, key string, value []byte) → error- Zweck
- Speichert den Kontodatensatz atomar unter seinem isolierten Schlüssel.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
errorKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
MemoryStore.Delete / SessionStore.Delete
Delete(ctx context.Context, key string) → error- Zweck
- Löscht den Kontodatensatz, aber keine Autorisierungscaches oder Abmeldeprotokolle des offiziellen SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
errorKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime.Start
Start(ctx context.Context, onError func(error)) → error- Zweck
- Startet SDK-Prüfung und Hintergrundpflege; Kontoanmeldung und Funktionsschutz haben eigene APIs.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.onError: Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Rückgabe
errorKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime.RunFeature
RunFeature(feature string, action func() error) → error- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
errorKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime.Deactivate
Deactivate(ctx context.Context) → error- Zweck
- Meldet das Gerät im offiziellen SDK ab; die Anwendung widerruft die Launch-Sitzung separat.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
errorKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime.Close
Close() → void- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
voidKein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Python
Zugehöriger Quellcode · v0.1.6 · client.py
Fehlerbehandlung: APIError.code / .status / .retry_after / .retryable; ValueError; SDK exceptions
Application.connect
Application.connect(merchant_origin, product_id, licentivo_product_id, trusted_keys, environment="live", **kwargs) → Application- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
merchantOrigin / origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productID / product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.licentivoProductID / licentivo_product_id: Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen.trustedKeys / trusted_keys: Zuordnung von Signaturschlüsselkennungen zu öffentlichen Schlüsseln zur Prüfung signierter SDK-Rechte.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application.login
login(email, password, *, pending_attempts=3) → Application (self)- Zweck
- Meldet das Kundenkonto an, holt eine kurzlebige Identitätsbestätigung und startet das offizielle Autorisierungs-SDK.
- Parameter
email, password: E-Mail und Passwort des Shop-Kundenkontos; Passwort nur für diese Anmeldung verwenden.pending_attempts: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
Application (self)Liefert diese Anwendungsinstanz, keine Kontodaten oder Autorisierungsentscheidung.
Application.restore
restore() → bool- Zweck
- Liest die gespeicherte Sitzung, bestätigt das Konto online, holt eine neue Identitätsbestätigung und startet das offizielle SDK.
- Rückgabe
booltrue bedeutet wiederhergestellt; false bedeutet keine wiederherstellbare Sitzung. Ablehnung, Ablauf und Netzwerkfehler werden als Fehler gemeldet.
Application.run_feature
run_feature(name, action) → T- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
TLiefert das Ergebnis des Geschäftsrückrufs; Autorisierungsfehler und Geschäftsausnahmen werden als Fehler gemeldet.
Application.logout
logout() → bool- Zweck
- Beendet lokale Autorisierung, meldet das offizielle SDK ab und widerruft die Launch-Sitzung. Offene Fernaufgaben bleiben zur Wiederholung erhalten.
- Rückgabe
booltrue bestätigt die Abmeldung; false bedeutet ausstehende Kontoabmeldung oder Gerätewiderruf. Speicherfehler können zusätzlich auftreten.
Application.release_device
release_device() → bool- Zweck
- Kompatibilitätseinstieg zur ausdrücklichen Abmeldung mit demselben Konto- und Geräteablauf wie Logout.
- Rückgabe
booltrue bestätigt die Abmeldung; false bedeutet ausstehende Kontoabmeldung oder Gerätewiderruf. Speicherfehler können zusätzlich auftreten.
Application.close
close() → None- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
NoneKein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Application.__enter__ / __exit__
with Application.connect(...) as app: ... → Application / None- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
Application / NoneKein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Erweiterte und Kompatibilitäts-APIs
Application.__init__
Application(origin, product_id, product_config, environment="live", store=None, runtime_factory=None, cache_dir=None, sleep=time.sleep, opener=None) → Application- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.product_config: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application.from_files
Application.from_files(launch_config, product_config, **kwargs) → Application- Zweck
- Liest zwei vorhandene öffentliche Konfigurationen, prüft die Produktzuordnung und erstellt die Anwendung. Direktverbindungen benötigen keine Dateien.
- Parameter
launch_config, product_config: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
MemoryStore
MemoryStore() → MemoryStore- Zweck
- Erstellt einen Sitzungsspeicher nur für den aktuellen Prozess.
- Rückgabe
MemoryStoreLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
WindowsDPAPIStore
WindowsDPAPIStore(directory=None) → WindowsDPAPIStore- Zweck
- Erstellt geschützten dauerhaften Sitzungsspeicher; der Schlüssel stammt aus dem Anmeldedatentresor des Betriebssystems.
- Parameter
directory: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
WindowsDPAPIStoreLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
APIError
APIError(code, status=0, retry_after=0) → APIError- Zweck
- Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Parameter
code, status, retry_after: Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Rückgabe
APIErrorLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
MemoryStore.load / WindowsDPAPIStore.load
load(key) → bytes | None- Zweck
- Lädt den Kontodatensatz per isoliertem Schlüssel; geheime Inhalte gehören ausschließlich ins SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
bytes | NoneLiefert den geheimen Datensatz; bei Fehlen folgen ein leerer Wert oder ErrNoSession gemäß Sprachvertrag.
MemoryStore.save / WindowsDPAPIStore.save
save(key, value) → None- Zweck
- Speichert den Kontodatensatz atomar unter seinem isolierten Schlüssel.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
NoneKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
MemoryStore.delete / WindowsDPAPIStore.delete
delete(key) → None- Zweck
- Löscht den Kontodatensatz, aber keine Autorisierungscaches oder Abmeldeprotokolle des offiziellen SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
NoneKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
C#
Zugehöriger Quellcode · v0.1.6 · Application.cs · SessionStore.cs
Fehlerbehandlung: await Task / ValueTask; LaunchException.Code / .Status / .RetryAfterSeconds / .Retryable
Application.Connect
Application.Connect(string merchantOrigin, string productId, string licentivoProductId, Dictionary<string,string> trustedKeys, string environment="live", ISessionStore? store=null, string? cacheDirectory=null) → Application- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
merchantOrigin / origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productID / product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.licentivoProductID / licentivo_product_id: Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen.trustedKeys / trusted_keys: Zuordnung von Signaturschlüsselkennungen zu öffentlichen Schlüsseln zur Prüfung signierter SDK-Rechte.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.store, cacheDirectory: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application.Login
Login(string email, string password, int pendingAttempts=3, CancellationToken ct=default) → Task- Zweck
- Meldet das Kundenkonto an, holt eine kurzlebige Identitätsbestätigung und startet das offizielle Autorisierungs-SDK.
- Parameter
email, password: E-Mail und Passwort des Shop-Kundenkontos; Passwort nur für diese Anmeldung verwenden.pendingAttempts: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
TaskKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application.Restore
Restore(CancellationToken ct=default) → Task<bool>- Zweck
- Liest die gespeicherte Sitzung, bestätigt das Konto online, holt eine neue Identitätsbestätigung und startet das offizielle SDK.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
Task<bool>true bedeutet wiederhergestellt; false bedeutet keine wiederherstellbare Sitzung. Ablehnung, Ablauf und Netzwerkfehler werden als Fehler gemeldet.
Application.RunFeature
RunFeature(string feature, Func<Task> action) → Task- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
TaskKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application.Status
Status() → AuthorizationStatus? (null: runtime absent)- Zweck
- Liest den Autorisierungsstatus des offiziellen SDK, ohne Anmeldung oder Ersatz der Funktionsprüfung.
- Rückgabe
AuthorizationStatus? (null: runtime absent)Liest den Autorisierungsstatus des offiziellen SDK, ohne Anmeldung oder Ersatz der Funktionsprüfung.
Application.Logout
Logout(CancellationToken ct=default) → Task- Zweck
- Beendet lokale Autorisierung, meldet das offizielle SDK ab und widerruft die Launch-Sitzung. Offene Fernaufgaben bleiben zur Wiederholung erhalten.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
TaskKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application.ReleaseDevice
ReleaseDevice(CancellationToken ct=default) → Task- Zweck
- Kompatibilitätseinstieg zur ausdrücklichen Abmeldung mit demselben Konto- und Geräteablauf wie Logout.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
TaskKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application.DisposeAsync
DisposeAsync() → ValueTask- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
ValueTaskKein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Erweiterte und Kompatibilitäts-APIs
Application
Application(string origin, string productId, Config productConfig, string environment="live", ISessionStore? store=null, string? cacheDirectory=null, HttpMessageHandler? handler=null, Func<Config,IRuntime>? runtimeFactory=null) → Application- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productId: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.productConfig: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application.FromFiles
Application.FromFiles(string launchPath, string productPath, ISessionStore? store=null) → Application- Zweck
- Liest zwei vorhandene öffentliche Konfigurationen, prüft die Produktzuordnung und erstellt die Anwendung. Direktverbindungen benötigen keine Dateien.
- Parameter
launchPath, productPath: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.store: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
MemoryStore
new MemoryStore() → MemoryStore- Zweck
- Erstellt einen Sitzungsspeicher nur für den aktuellen Prozess.
- Rückgabe
MemoryStoreLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
WindowsDPAPIStore
new WindowsDPAPIStore(string? directory=null) → WindowsDPAPIStore- Zweck
- Erstellt geschützten dauerhaften Sitzungsspeicher; der Schlüssel stammt aus dem Anmeldedatentresor des Betriebssystems.
- Parameter
directory: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
WindowsDPAPIStoreLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
LaunchException
new LaunchException(string code, int status=0, int retryAfterSeconds=0) → LaunchException- Zweck
- Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Parameter
code, status, retryAfterSeconds: Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Rückgabe
LaunchExceptionLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
ISessionStore.Load / MemoryStore.Load / WindowsDPAPIStore.Load
Load(string key) → byte[]?- Zweck
- Lädt den Kontodatensatz per isoliertem Schlüssel; geheime Inhalte gehören ausschließlich ins SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
byte[]?Liefert den geheimen Datensatz; bei Fehlen folgen ein leerer Wert oder ErrNoSession gemäß Sprachvertrag.
ISessionStore.Save / MemoryStore.Save / WindowsDPAPIStore.Save
Save(string key, byte[] value) → void- Zweck
- Speichert den Kontodatensatz atomar unter seinem isolierten Schlüssel.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
ISessionStore.Delete / MemoryStore.Delete / WindowsDPAPIStore.Delete
Delete(string key) → void- Zweck
- Löscht den Kontodatensatz, aber keine Autorisierungscaches oder Abmeldeprotokolle des offiziellen SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
IRuntime.Start
Start(CancellationToken ct) → Task- Zweck
- Startet SDK-Prüfung und Hintergrundpflege; Kontoanmeldung und Funktionsschutz haben eigene APIs.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
TaskKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
IRuntime.Status
Status() → AuthorizationStatus- Zweck
- Liest den Autorisierungsstatus des offiziellen SDK, ohne Anmeldung oder Ersatz der Funktionsprüfung.
- Rückgabe
AuthorizationStatusLiest den Autorisierungsstatus des offiziellen SDK, ohne Anmeldung oder Ersatz der Funktionsprüfung.
IRuntime.RunFeature
RunFeature(string feature, Func<Task> action) → Task- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
TaskKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
IRuntime.Deactivate
Deactivate(CancellationToken ct) → Task- Zweck
- Meldet das Gerät im offiziellen SDK ab; die Anwendung widerruft die Launch-Sitzung separat.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
TaskKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
IRuntime.DisposeAsync
DisposeAsync() → ValueTask- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
ValueTaskKein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Java
Zugehöriger Quellcode · v0.1.6 · Launch.java · EncryptedFileStore.java
Fehlerbehandlung: throws Exception; Launch.Failure.code / .status / .requestID / .retryAfterMillis / .transport; char[] password
Launch.connect
Launch.connect(String merchantOrigin, String productId, String licentivoProductId, Map<String,String> trustedKeys, String environment) → Launch- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
merchantOrigin / origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productID / product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.licentivoProductID / licentivo_product_id: Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen.trustedKeys / trusted_keys: Zuordnung von Signaturschlüsselkennungen zu öffentlichen Schlüsseln zur Prüfung signierter SDK-Rechte.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.
- Rückgabe
LaunchLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Launch.login
login(String email, char[] password) → State- Zweck
- Meldet das Kundenkonto an, holt eine kurzlebige Identitätsbestätigung und startet das offizielle Autorisierungs-SDK.
- Parameter
email, password: E-Mail und Passwort des Shop-Kundenkontos; Passwort nur für diese Anmeldung verwenden.
- Rückgabe
StateLiefert den Kontostatus; Feldbedeutungen stehen in der folgenden Tabelle.
Launch.restore
restore() → State- Zweck
- Liest die gespeicherte Sitzung, bestätigt das Konto online, holt eine neue Identitätsbestätigung und startet das offizielle SDK.
- Rückgabe
StateLiefert den Kontostatus; ErrNoSession oder NO_SESSION bedeutet keine gespeicherte Sitzung. Andere Fehler gesondert behandeln.
Launch.runFeature
runFeature(String feature, Client.FeatureAction action) → void- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Launch.logout
logout() → void- Zweck
- Beendet lokale Autorisierung, meldet das offizielle SDK ab und widerruft die Launch-Sitzung. Offene Fernaufgaben bleiben zur Wiederholung erhalten.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Launch.releaseDevice
releaseDevice() → void- Zweck
- Kompatibilitätseinstieg zur ausdrücklichen Abmeldung mit demselben Konto- und Geräteablauf wie Logout.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Launch.close
close() → void- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
voidKein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Erweiterte und Kompatibilitäts-APIs
Launch
new Launch(Config config, Map<String,Object> product, Path cacheRoot [, Store store, Transport transport, RuntimeFactory factory, Sleeper sleeper]) → Launch- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
config, product: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.cacheRoot: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.store, transport, factory, sleeper: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
LaunchLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Launch.Config
new Launch.Config(String merchantOrigin, String launchProductID, String licentivoProductID, String environment) → Config- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
merchantOrigin / origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productID / product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.licentivoProductID / licentivo_product_id: Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.
- Rückgabe
ConfigLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
Launch.Config.load
Launch.Config.load(Path path) → Config- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
path: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
ConfigLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
Launch.readPublic
Launch.readPublic(Path path) → Map<String,Object>- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
path: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
Map<String,Object>Liefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
Launch.MemoryStore
new Launch.MemoryStore() → MemoryStore- Zweck
- Erstellt einen Sitzungsspeicher nur für den aktuellen Prozess.
- Rückgabe
MemoryStoreLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
EncryptedFileStore
new EncryptedFileStore(Path directory, SecretKey vaultKey) → EncryptedFileStore- Zweck
- Erstellt geschützten dauerhaften Sitzungsspeicher; der Schlüssel stammt aus dem Anmeldedatentresor des Betriebssystems.
- Parameter
directory: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.vaultKey: Verschlüsselungsschlüssel aus dem Betriebssystemtresor; niemals neben verschlüsselten Datensätzen speichern.
- Rückgabe
EncryptedFileStoreLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Launch.HTTPTransport.request
request(String method, URI uri, String bearer, byte[] body) → Response- Zweck
- Sendet Konto-HTTP-Anfragen und liefert Status, Header oder Rohdaten, ohne Autorisierung zu entscheiden.
- Parameter
method, uri, bearer, body: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
ResponseLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
Launch.Failure
new Launch.Failure(String code [, int status, String requestID, long retryAfterMillis, boolean transport]) → Failure- Zweck
- Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Parameter
code, status, requestID, retryAfterMillis, transport: Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Rückgabe
FailureLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
Launch.Failure.unavailable
unavailable() → boolean- Zweck
- Erkennt vorübergehende Nichtverfügbarkeit; dies erlaubt niemals Offline-Autorisierung.
- Rückgabe
booleanLiefert eine boolesche Klassifikation, keine Autorisierung.
Store.load / MemoryStore.load / EncryptedFileStore.load
load(String scope) → byte[] | null- Zweck
- Lädt den Kontodatensatz per isoliertem Schlüssel; geheime Inhalte gehören ausschließlich ins SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
byte[] | nullLiefert den geheimen Datensatz; bei Fehlen folgen ein leerer Wert oder ErrNoSession gemäß Sprachvertrag.
Store.save / MemoryStore.save / EncryptedFileStore.save
save(String scope, byte[] secret) → void- Zweck
- Speichert den Kontodatensatz atomar unter seinem isolierten Schlüssel.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Store.delete / MemoryStore.delete / EncryptedFileStore.delete
delete(String scope) → void- Zweck
- Löscht den Kontodatensatz, aber keine Autorisierungscaches oder Abmeldeprotokolle des offiziellen SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime.canStartOffline
canStartOffline() → boolean- Zweck
- Liest den Autorisierungsstatus des offiziellen SDK, ohne Anmeldung oder Ersatz der Funktionsprüfung.
- Rückgabe
booleanLiefert eine boolesche Klassifikation, keine Autorisierung.
Runtime.start
start() → void- Zweck
- Startet SDK-Prüfung und Hintergrundpflege; Kontoanmeldung und Funktionsschutz haben eigene APIs.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime.runFeature
runFeature(String feature, Client.FeatureAction action) → void- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime.releaseDevice
releaseDevice() → void- Zweck
- Meldet das Gerät im offiziellen SDK ab; die Anwendung widerruft die Launch-Sitzung separat.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime.close
close() → void- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
voidKein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
RuntimeFactory.create
create(Map<String,Object> settings) → Runtime- Zweck
- Erstellt den offiziellen SDK-Adapter für erweiterte Integrationen; die Identitätsbestätigung bleibt im Speicher.
- Parameter
settings: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
RuntimeLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Sleeper.sleep
sleep(long milliseconds) → void- Zweck
- Wartet die angegebene Dauer für erweiterte Wiederholungsplanung.
- Parameter
milliseconds: Empfohlene Wartezeit; Sekunden, Millisekunden und Duration je Sprache unterscheiden.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
JavaScript / TypeScript
Zugehöriger Quellcode · v0.1.6 · index.d.ts · index.mjs
Fehlerbehandlung: await Promise; catch (error); LaunchError(code, status, retryAfterSeconds)
Application.connect
Application.connect(merchantOrigin, productID, licentivoProductID, trustedKeys, options?) → Application- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
merchantOrigin / origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productID / product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.licentivoProductID / licentivo_product_id: Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen.trustedKeys / trusted_keys: Zuordnung von Signaturschlüsselkennungen zu öffentlichen Schlüsseln zur Prüfung signierter SDK-Rechte.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application.login
login(email: string, password: string, options?: {signal?: AbortSignal}) → Promise<SessionState>- Zweck
- Meldet das Kundenkonto an, holt eine kurzlebige Identitätsbestätigung und startet das offizielle Autorisierungs-SDK.
- Parameter
email, password: E-Mail und Passwort des Shop-Kundenkontos; Passwort nur für diese Anmeldung verwenden.ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
Promise<SessionState>Liefert den Kontostatus; Feldbedeutungen stehen in der folgenden Tabelle.
Application.restore
restore(options?: {signal?: AbortSignal}) → Promise<SessionState | null>- Zweck
- Liest die gespeicherte Sitzung, bestätigt das Konto online, holt eine neue Identitätsbestätigung und startet das offizielle SDK.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
Promise<SessionState | null>Liefert den Kontostatus; null oder nil bedeutet keine wiederherstellbare Sitzung. Andere Fehler werden separat gemeldet.
Application.runFeature
runFeature<T>(name: string, action: () => T | Promise<T>) → Promise<T>- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
Promise<T>Liefert das Ergebnis des Geschäftsrückrufs; Autorisierungsfehler und Geschäftsausnahmen werden als Fehler gemeldet.
Application.logout
logout(options?: {signal?: AbortSignal}) → Promise<boolean>- Zweck
- Beendet lokale Autorisierung, meldet das offizielle SDK ab und widerruft die Launch-Sitzung. Offene Fernaufgaben bleiben zur Wiederholung erhalten.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
Promise<boolean>true bestätigt die Abmeldung; false bedeutet ausstehende Kontoabmeldung oder Gerätewiderruf. Speicherfehler können zusätzlich auftreten.
Application.releaseDevice
releaseDevice(options?: {signal?: AbortSignal}) → Promise<void>- Zweck
- Kompatibilitätseinstieg zur ausdrücklichen Abmeldung mit demselben Konto- und Geräteablauf wie Logout.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
Promise<void>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application.close
close() → Promise<void>- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
Promise<void>Kein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Erweiterte und Kompatibilitäts-APIs
Application
new Application(launch: LaunchConfig, product: PublicProductConfig, options?: Options) → Application- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
launch, product: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application.fromFiles
Application.fromFiles(launchPath: string, productPath: string, options?: Options) → Promise<Application>- Zweck
- Liest zwei vorhandene öffentliche Konfigurationen, prüft die Produktzuordnung und erstellt die Anwendung. Direktverbindungen benötigen keine Dateien.
- Parameter
launchPath, productPath: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
Promise<Application>Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
validateConfig
validateConfig(launch: LaunchConfig, product: PublicProductConfig) → {launch: LaunchConfig, product: PublicProductConfig}- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
launch, product: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
{launch: LaunchConfig, product: PublicProductConfig}Liefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
loadConfig
loadConfig(launchPath: string, productPath: string) → Promise<{launch: LaunchConfig, product: PublicProductConfig}>- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
launchPath, productPath: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
Promise<{launch: LaunchConfig, product: PublicProductConfig}>Liefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
defaultTransport
defaultTransport(request: Request) → Promise<Response>- Zweck
- Sendet Konto-HTTP-Anfragen und liefert Status, Header oder Rohdaten, ohne Autorisierung zu entscheiden.
- Parameter
request: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
Promise<Response>Liefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
MemoryStore
new MemoryStore() → MemoryStore- Zweck
- Erstellt einen Sitzungsspeicher nur für den aktuellen Prozess.
- Rückgabe
MemoryStoreLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
EncryptedFileStore
new EncryptedFileStore(directory: string, key: Uint8Array) → EncryptedFileStore- Zweck
- Erstellt geschützten dauerhaften Sitzungsspeicher; der Schlüssel stammt aus dem Anmeldedatentresor des Betriebssystems.
- Parameter
directory: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.key: Verschlüsselungsschlüssel aus dem Betriebssystemtresor; niemals neben verschlüsselten Datensätzen speichern.
- Rückgabe
EncryptedFileStoreLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
LaunchError
new LaunchError(code: string, status=0, retryAfterSeconds=0) → LaunchError- Zweck
- Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Parameter
code, status, retryAfterSeconds: Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Rückgabe
LaunchErrorLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
SessionStore.load / MemoryStore.load / EncryptedFileStore.load
load(scope: string) → Promise<SavedSession | null>- Zweck
- Lädt den Kontodatensatz per isoliertem Schlüssel; geheime Inhalte gehören ausschließlich ins SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
Promise<SavedSession | null>Liefert den geheimen Datensatz; bei Fehlen folgen ein leerer Wert oder ErrNoSession gemäß Sprachvertrag.
SessionStore.save / MemoryStore.save / EncryptedFileStore.save
save(scope: string, value: SavedSession) → Promise<void>- Zweck
- Speichert den Kontodatensatz atomar unter seinem isolierten Schlüssel.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
Promise<void>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
SessionStore.delete / MemoryStore.delete / EncryptedFileStore.delete
delete(scope: string) → Promise<void>- Zweck
- Löscht den Kontodatensatz, aber keine Autorisierungscaches oder Abmeldeprotokolle des offiziellen SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
Promise<void>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime.status
status() → {allowed:boolean,state:string} | Promise<{allowed:boolean,state:string}>- Zweck
- Liest den Autorisierungsstatus des offiziellen SDK, ohne Anmeldung oder Ersatz der Funktionsprüfung.
- Rückgabe
{allowed:boolean,state:string} | Promise<{allowed:boolean,state:string}>Liest den Autorisierungsstatus des offiziellen SDK, ohne Anmeldung oder Ersatz der Funktionsprüfung.
Runtime.start
start(onError?: (error: unknown) => void, signal?: AbortSignal) → Promise<unknown>- Zweck
- Startet SDK-Prüfung und Hintergrundpflege; Kontoanmeldung und Funktionsschutz haben eigene APIs.
- Parameter
onError: Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
Promise<unknown>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime.runFeature
runFeature<T>(name: string, action: () => T | Promise<T>) → Promise<T>- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
Promise<T>Liefert das Ergebnis des Geschäftsrückrufs; Autorisierungsfehler und Geschäftsausnahmen werden als Fehler gemeldet.
Runtime.deactivate
deactivate(signal?: AbortSignal) → Promise<unknown>- Zweck
- Meldet das Gerät im offiziellen SDK ab; die Anwendung widerruft die Launch-Sitzung separat.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
Promise<unknown>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime.logout
logout?(signal?: AbortSignal) → Promise<{local_complete:boolean,revocation_pending:boolean,storage_error?:string}>- Zweck
- Meldet das Gerät im offiziellen SDK ab; die Anwendung widerruft die Launch-Sitzung separat.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
Promise<{local_complete:boolean,revocation_pending:boolean,storage_error?:string}>Lokale Abmeldung und Fernwiderruf sind getrennte Zustände. Offene Vorgänge und Speicherfehler behandeln; SDK-Abmeldeprotokoll erhalten.
Runtime.close
close() → Promise<unknown>- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
Promise<unknown>Kein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Rust
Zugehöriger Quellcode · v0.1.6 · lib.rs · store.rs · transport.rs
Fehlerbehandlung: Result<T, Failure>: Ok(value) / Err(Failure {code, status, request_id, retry_after, transport})
Application::connect
Application::connect(origin: &str, product_id: &str, licentivo_product_id: &str, trusted_keys: &[(&str,&str)], environment: &str) → Result<Application, Failure>- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
merchantOrigin / origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productID / product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.licentivoProductID / licentivo_product_id: Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen.trustedKeys / trusted_keys: Zuordnung von Signaturschlüsselkennungen zu öffentlichen Schlüsseln zur Prüfung signierter SDK-Rechte.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.
- Rückgabe
Result<Application, Failure>Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application::login
login(&mut self, email: &str, password: &str) → Result<State, Failure>- Zweck
- Meldet das Kundenkonto an, holt eine kurzlebige Identitätsbestätigung und startet das offizielle Autorisierungs-SDK.
- Parameter
email, password: E-Mail und Passwort des Shop-Kundenkontos; Passwort nur für diese Anmeldung verwenden.
- Rückgabe
Result<State, Failure>Liefert den Kontostatus; Feldbedeutungen stehen in der folgenden Tabelle.
Application::restore
restore(&mut self) → Result<State, Failure>- Zweck
- Liest die gespeicherte Sitzung, bestätigt das Konto online, holt eine neue Identitätsbestätigung und startet das offizielle SDK.
- Rückgabe
Result<State, Failure>Liefert den Kontostatus; ErrNoSession oder NO_SESSION bedeutet keine gespeicherte Sitzung. Andere Fehler gesondert behandeln.
Application::run_feature
run_feature<T,F: FnOnce() -> Result<T,Failure>>(&mut self, feature: &str, action: F) → Result<T, Failure>- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
Result<T, Failure>Liefert das Ergebnis des Geschäftsrückrufs; Autorisierungsfehler und Geschäftsausnahmen werden als Fehler gemeldet.
Application::logout
logout(&mut self) → Result<(), Failure>- Zweck
- Beendet lokale Autorisierung, meldet das offizielle SDK ab und widerruft die Launch-Sitzung. Offene Fernaufgaben bleiben zur Wiederholung erhalten.
- Rückgabe
Result<(), Failure>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application::release_device
release_device(&mut self) → Result<(), Failure>- Zweck
- Kompatibilitätseinstieg zur ausdrücklichen Abmeldung mit demselben Konto- und Geräteablauf wie Logout.
- Rückgabe
Result<(), Failure>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application::close / Drop
close(&mut self) / drop(&mut self) → ()- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
()Kein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Erweiterte und Kompatibilitäts-APIs
Application::new
Application::new(config: Config, product: Value, cache_root: PathBuf) → Result<Application, Failure>- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
config, product: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.cache_root: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
Result<Application, Failure>Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application::with_components
Application::with_components(config: Config, product: Value, cache_root: PathBuf, store: Box<dyn Store>, transport: Box<dyn Transport>, factory: Box<dyn RuntimeFactory>, sleeper: Box<dyn Sleeper>) → Result<Application, Failure>- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
config, product: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.cache_root: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.store, transport, factory, sleeper: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
Result<Application, Failure>Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Config::new
Config::new(origin: &str, product: &str, runtime_product: &str, environment: &str) → Result<Config, Failure>- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
merchantOrigin / origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productID / product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.licentivoProductID / licentivo_product_id: Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.
- Rückgabe
Result<Config, Failure>Liefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
Config::load
Config::load(path: impl AsRef<Path>) → Result<Config, Failure>- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
path: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
Result<Config, Failure>Liefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
read_public
read_public(path: impl AsRef<Path>) → Result<Value, Failure>- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
path: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
Result<Value, Failure>Liefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
MemoryStore::default
MemoryStore::default() → MemoryStore- Zweck
- Erstellt einen Sitzungsspeicher nur für den aktuellen Prozess.
- Rückgabe
MemoryStoreLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
EncryptedFileStore::new
EncryptedFileStore::new(root: PathBuf, vault_key: [u8;32]) → Result<EncryptedFileStore, Failure>- Zweck
- Erstellt geschützten dauerhaften Sitzungsspeicher; der Schlüssel stammt aus dem Anmeldedatentresor des Betriebssystems.
- Parameter
root: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.vault_key: Verschlüsselungsschlüssel aus dem Betriebssystemtresor; niemals neben verschlüsselten Datensätzen speichern.
- Rückgabe
Result<EncryptedFileStore, Failure>Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
CurlTransport::new
CurlTransport::new() → Result<CurlTransport, Failure>- Zweck
- Sendet Konto-HTTP-Anfragen und liefert Status, Header oder Rohdaten, ohne Autorisierung zu entscheiden.
- Rückgabe
Result<CurlTransport, Failure>Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
CurlTransport::request
request(&mut self, method: &str, url: &str, bearer: &str, body: &[u8]) → Result<Response, Failure>- Zweck
- Sendet Konto-HTTP-Anfragen und liefert Status, Header oder Rohdaten, ohne Autorisierung zu entscheiden.
- Parameter
method, url, bearer, body: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
Result<Response, Failure>Liefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
Failure::new
Failure::new(code: &str) → Failure- Zweck
- Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Parameter
code: Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Rückgabe
FailureLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
ThreadSleeper::sleep
sleep(&mut self, duration: Duration) → Result<(), Failure>- Zweck
- Wartet die angegebene Dauer für erweiterte Wiederholungsplanung.
- Parameter
duration: Empfohlene Wartezeit; Sekunden, Millisekunden und Duration je Sprache unterscheiden.
- Rückgabe
Result<(), Failure>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Store::load / MemoryStore::load / EncryptedFileStore::load
load(&mut self, scope: &str) → Result<Option<Vec<u8>>, Failure>- Zweck
- Lädt den Kontodatensatz per isoliertem Schlüssel; geheime Inhalte gehören ausschließlich ins SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
Result<Option<Vec<u8>>, Failure>Liefert den geheimen Datensatz; bei Fehlen folgen ein leerer Wert oder ErrNoSession gemäß Sprachvertrag.
Store::save / MemoryStore::save / EncryptedFileStore::save
save(&mut self, scope: &str, value: &[u8]) → Result<(), Failure>- Zweck
- Speichert den Kontodatensatz atomar unter seinem isolierten Schlüssel.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
Result<(), Failure>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Store::delete / MemoryStore::delete / EncryptedFileStore::delete
delete(&mut self, scope: &str) → Result<(), Failure>- Zweck
- Löscht den Kontodatensatz, aber keine Autorisierungscaches oder Abmeldeprotokolle des offiziellen SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
Result<(), Failure>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime::run_feature
run_feature(&mut self, feature: &str, action: &mut dyn FnMut() -> Result<(),Failure>) → Result<(), Failure>- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
Result<(), Failure>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime::release_device
release_device(&mut self) → Result<(), Failure>- Zweck
- Meldet das Gerät im offiziellen SDK ab; die Anwendung widerruft die Launch-Sitzung separat.
- Rückgabe
Result<(), Failure>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Runtime::close
close(&mut self) → ()- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
()Kein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
RuntimeFactory::open / OfficialRuntimeFactory::open
open(&mut self, settings: &Value, cached_only: bool) → Result<Box<dyn Runtime>, Failure>- Zweck
- Erstellt den offiziellen SDK-Adapter für erweiterte Integrationen; die Identitätsbestätigung bleibt im Speicher.
- Parameter
settings, cached_only: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
Result<Box<dyn Runtime>, Failure>Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
RuntimeFactory::for_logout / OfficialRuntimeFactory::for_logout
for_logout(&mut self, settings: &Value) → Result<Box<dyn Runtime>, Failure>- Zweck
- Erstellt den offiziellen SDK-Adapter für erweiterte Integrationen; die Identitätsbestätigung bleibt im Speicher.
- Parameter
settings: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
Result<Box<dyn Runtime>, Failure>Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Sleeper::sleep
sleep(&mut self, duration: Duration) → Result<(), Failure>- Zweck
- Wartet die angegebene Dauer für erweiterte Wiederholungsplanung.
- Parameter
duration: Empfohlene Wartezeit; Sekunden, Millisekunden und Duration je Sprache unterscheiden.
- Rückgabe
Result<(), Failure>Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Ruby
Zugehöriger Quellcode · v0.1.6 · licentivo_launch.rb
Fehlerbehandlung: rescue LicentivoLaunch::Error; code / status / retry_after_seconds; callback exceptions
Application.connect
LicentivoLaunch::Application.connect(merchant_origin, product_id, licentivo_product_id, trusted_keys, environment: "live", **options) → Application- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
merchantOrigin / origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productID / product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.licentivoProductID / licentivo_product_id: Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen.trustedKeys / trusted_keys: Zuordnung von Signaturschlüsselkennungen zu öffentlichen Schlüsseln zur Prüfung signierter SDK-Rechte.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application#login
login(email, password, cancellation: nil) → Hash- Zweck
- Meldet das Kundenkonto an, holt eine kurzlebige Identitätsbestätigung und startet das offizielle Autorisierungs-SDK.
- Parameter
email, password: E-Mail und Passwort des Shop-Kundenkontos; Passwort nur für diese Anmeldung verwenden.ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
HashLiefert den Kontostatus; Feldbedeutungen stehen in der folgenden Tabelle.
Application#restore
restore(cancellation: nil) → Hash | nil- Zweck
- Liest die gespeicherte Sitzung, bestätigt das Konto online, holt eine neue Identitätsbestätigung und startet das offizielle SDK.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
Hash | nilLiefert den Kontostatus; null oder nil bedeutet keine wiederherstellbare Sitzung. Andere Fehler werden separat gemeldet.
Application#run_feature
run_feature(feature) { ... } → T- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
TLiefert das Ergebnis des Geschäftsrückrufs; Autorisierungsfehler und Geschäftsausnahmen werden als Fehler gemeldet.
Application#logout
logout(cancellation: nil) → true | false- Zweck
- Beendet lokale Autorisierung, meldet das offizielle SDK ab und widerruft die Launch-Sitzung. Offene Fernaufgaben bleiben zur Wiederholung erhalten.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
true | falsetrue bestätigt die Abmeldung; false bedeutet ausstehende Kontoabmeldung oder Gerätewiderruf. Speicherfehler können zusätzlich auftreten.
Application#release_device
release_device(cancellation: nil) → true | false- Zweck
- Kompatibilitätseinstieg zur ausdrücklichen Abmeldung mit demselben Konto- und Geräteablauf wie Logout.
- Parameter
ctx / ct / signal / cancellation: Anfragekontext oder Abbruchsignal; der Go-Lebenszykluskontext steuert auch Hintergrundaufgaben.
- Rückgabe
true | falsetrue bestätigt die Abmeldung; false bedeutet ausstehende Kontoabmeldung oder Gerätewiderruf. Speicherfehler können zusätzlich auftreten.
Application#close
close → nil- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
nilKein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Erweiterte und Kompatibilitäts-APIs
Application.new
Application.new(launch, product, store: MemoryStore.new, transport: nil, runtime_factory: nil, cache_dir: nil, sleep: nil, pending_attempts: 5) → Application- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
launch, product: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application.from_files
Application.from_files(launch_path, product_path, **options) → Application- Zweck
- Liest zwei vorhandene öffentliche Konfigurationen, prüft die Produktzuordnung und erstellt die Anwendung. Direktverbindungen benötigen keine Dateien.
- Parameter
launchPath, productPath: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.options / config: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
LicentivoLaunch.origin
LicentivoLaunch.origin(value, environment) → String- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
value: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.
- Rückgabe
StringLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
LicentivoLaunch.validate_config
LicentivoLaunch.validate_config(launch, product) → [Hash, Hash]- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
launch, product: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
[Hash, Hash]Liefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
LicentivoLaunch.load_config
LicentivoLaunch.load_config(launch_path, product_path) → [Hash, Hash]- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
launchPath, productPath: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.
- Rückgabe
[Hash, Hash]Liefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
LicentivoLaunch.default_transport
LicentivoLaunch.default_transport(request) → Hash- Zweck
- Sendet Konto-HTTP-Anfragen und liefert Status, Header oder Rohdaten, ohne Autorisierung zu entscheiden.
- Parameter
request: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
HashLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
MemoryStore.new
MemoryStore.new → MemoryStore- Zweck
- Erstellt einen Sitzungsspeicher nur für den aktuellen Prozess.
- Rückgabe
MemoryStoreLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
EncryptedFileStore.new
EncryptedFileStore.new(directory, key) → EncryptedFileStore- Zweck
- Erstellt geschützten dauerhaften Sitzungsspeicher; der Schlüssel stammt aus dem Anmeldedatentresor des Betriebssystems.
- Parameter
directory: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.key: Verschlüsselungsschlüssel aus dem Betriebssystemtresor; niemals neben verschlüsselten Datensätzen speichern.
- Rückgabe
EncryptedFileStoreLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
MemoryStore#persistent? / EncryptedFileStore#persistent? / #secure?
persistent? / secure? → true | false- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Rückgabe
true | falseLiefert eine boolesche Klassifikation, keine Autorisierung.
EncryptedFileStore#path
path(scope) → String- Zweck
- Prüft oder liest öffentliche Einstellungen; Produktkennungen, Umgebung und Signaturschlüssel müssen übereinstimmen.
- Parameter
scope: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
StringLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
CancellationToken#cancel / #check!
CancellationToken.new.cancel / check! → true / nil- Zweck
- Fordert kooperativen Abbruch an oder prüft ihn; Abbruch bedeutet keine erfolgreiche Autorisierung.
- Rückgabe
true / nilKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Error.new
Error.new(code, status: 0, retry_after_seconds: 0) → Error- Zweck
- Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Parameter
code, status, retry_after_seconds: Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Rückgabe
ErrorLiefert den in der Signatur angegebenen Werttyp; der Rückgabewert erteilt keine Funktionsrechte.
MemoryStore#load / EncryptedFileStore#load
load(scope) → Hash | nil- Zweck
- Lädt den Kontodatensatz per isoliertem Schlüssel; geheime Inhalte gehören ausschließlich ins SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
Hash | nilLiefert den geheimen Datensatz; bei Fehlen folgen ein leerer Wert oder ErrNoSession gemäß Sprachvertrag.
MemoryStore#save / EncryptedFileStore#save
save(scope, record) → Object- Zweck
- Speichert den Kontodatensatz atomar unter seinem isolierten Schlüssel.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
ObjectKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
MemoryStore#delete / EncryptedFileStore#delete
delete(scope) → Object- Zweck
- Löscht den Kontodatensatz, aber keine Autorisierungscaches oder Abmeldeprotokolle des offiziellen SDK.
- Parameter
scope / key, value / record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
ObjectKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
C
Zugehöriger Quellcode · v0.1.6 · account.h · account.c
Fehlerbehandlung: NULL / 0 / -1; launch_application_error(app); action(context): 1=success, 0=failure
launch_application_connect
launch_application_connect(origin, product_id, licentivo_product_id, trusted_keys_json, environment, remember, store) → launch_application *- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
merchantOrigin / origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productID / product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.licentivoProductID / licentivo_product_id: Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen.trustedKeys / trusted_keys: Zuordnung von Signaturschlüsselkennungen zu öffentlichen Schlüsseln zur Prüfung signierter SDK-Rechte.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.remember, store: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
launch_application *Liefert einen eigenen Anwendungszeiger; NULL bedeutet Initialisierungsfehler. Mit close freigeben.
launch_application_login
launch_application_login(launch_application *app, const char *email, const char *password) → int- Zweck
- Meldet das Kundenkonto an, holt eine kurzlebige Identitätsbestätigung und startet das offizielle Autorisierungs-SDK.
- Parameter
email, password: E-Mail und Passwort des Shop-Kundenkontos; Passwort nur für diese Anmeldung verwenden.
- Rückgabe
int1 bedeutet Erfolg, 0 Fehler. Nach einem Fehler den Fehlercode lesen.
launch_application_restore
launch_application_restore(launch_application *app) → int- Zweck
- Liest die gespeicherte Sitzung, bestätigt das Konto online, holt eine neue Identitätsbestätigung und startet das offizielle SDK.
- Rückgabe
int1 bedeutet wiederhergestellt, 0 keine Sitzung, -1 Ablehnung oder Fehler. Danach Fehlercode lesen.
launch_application_run_feature
launch_application_run_feature(app, feature, ln_feature_action action, void *context) → int- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.context: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
int1 bedeutet Erfolg, 0 Fehler. Nach einem Fehler den Fehlercode lesen.
launch_application_logout
launch_application_logout(launch_application *app) → int- Zweck
- Beendet lokale Autorisierung, meldet das offizielle SDK ab und widerruft die Launch-Sitzung. Offene Fernaufgaben bleiben zur Wiederholung erhalten.
- Rückgabe
int1 bedeutet Erfolg, 0 Fehler. Nach einem Fehler den Fehlercode lesen.
launch_application_release_device
launch_application_release_device(launch_application *app) → int- Zweck
- Kompatibilitätseinstieg zur ausdrücklichen Abmeldung mit demselben Konto- und Geräteablauf wie Logout.
- Rückgabe
int1 bedeutet Erfolg, 0 Fehler. Nach einem Fehler den Fehlercode lesen.
launch_application_status
launch_application_status(launch_application *app) → char *- Zweck
- Liest den Autorisierungsstatus des offiziellen SDK, ohne Anmeldung oder Ersatz der Funktionsprüfung.
- Rückgabe
char *Liefert eigenen JSON-Text, mit ln_free_string freigeben. Ohne Laufzeit: login_required und allowed=false.
launch_application_error
launch_application_error(const launch_application *app) → const char *- Zweck
- Erstellt oder liest strukturierte Fehler für Klassifizierung, Wartezeiten und korrelierte Diagnose.
- Rückgabe
const char *Liefert eine geliehene Fehlerzeichenfolge. Nicht freigeben oder nach Zerstörung der Anwendung verwenden.
launch_application_close
launch_application_close(launch_application *app) → void- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
voidKein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Erweiterte und Kompatibilitäts-APIs
launch_application_open
launch_application_open(origin, product_id, product_config_path, environment, remember, store) → launch_application *- Zweck
- Liest zwei vorhandene öffentliche Konfigurationen, prüft die Produktzuordnung und erstellt die Anwendung. Direktverbindungen benötigen keine Dateien.
- Parameter
origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.product_config_path: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.remember, store: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
launch_application *Liefert einen eigenen Anwendungszeiger; NULL bedeutet Initialisierungsfehler. Mit close freigeben.
launch_application_from_files
launch_application_from_files(launch_config_path, product_config_path, remember, store) → launch_application *- Zweck
- Liest zwei vorhandene öffentliche Konfigurationen, prüft die Produktzuordnung und erstellt die Anwendung. Direktverbindungen benötigen keine Dateien.
- Parameter
launchPath, productPath: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.remember, store: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
launch_application *Liefert einen eigenen Anwendungszeiger; NULL bedeutet Initialisierungsfehler. Mit close freigeben.
launch_application_cli
launch_application_cli(int argc, char **argv) → launch_application *- Zweck
- Liest zwei vorhandene öffentliche Konfigurationen, prüft die Produktzuordnung und erstellt die Anwendung. Direktverbindungen benötigen keine Dateien.
- Parameter
argc, argv: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
launch_application *Liefert einen eigenen Anwendungszeiger; NULL bedeutet Initialisierungsfehler. Mit close freigeben.
launch_login / launch_sign_in
launch_login(account, origin, product_id, config_path, environment, email, password) / launch_sign_in(account, argc, argv) → int- Zweck
- Beibehaltene Alt-API: Das Protokoll langfristiger Lizenzzugangsdaten wurde entfernt, daher schlagen Aufrufe fehl. Verwenden Sie Application.
- Parameter
account, origin, product_id, config_path, environment, email, password, argc, argv: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
intSchlägt immer fehl; auf Kontoidentitätsaustausch umstellen.
launch_sign_out
launch_sign_out(launch_account *account, int clear_cache) → void- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Parameter
account, clear_cache: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
ln_free_string
ln_free_string(char *value) → void- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Parameter
value: Liefert eigenen JSON-Text, mit ln_free_string freigeben. Ohne Laufzeit: login_required und allowed=false.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
launch_secret_store.load
load(void *context, const char *scope, char **record) → int- Zweck
- Lädt den Kontodatensatz per isoliertem Schlüssel; geheime Inhalte gehören ausschließlich ins SDK.
- Parameter
context: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.scope, record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
int1 gefunden, 0 fehlt, -1 Lesefehler. load reserviert record; der Aufrufer gibt ihn frei.
launch_secret_store.save
save(void *context, const char *scope, const char *record) → int (1: success, 0: failure)- Zweck
- Speichert den Kontodatensatz atomar unter seinem isolierten Schlüssel.
- Parameter
context: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.scope, record: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
int (1: success, 0: failure)Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
launch_secret_store.remove
remove(void *context, const char *scope) → int (1: success, 0: failure)- Zweck
- Löscht den Kontodatensatz, aber keine Autorisierungscaches oder Abmeldeprotokolle des offiziellen SDK.
- Parameter
context: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.scope: Isolationsschlüssel und geheime SDK-Datensätze; eigener Speicher muss mehrere Schlüssel und atomaren Austausch unterstützen.
- Rückgabe
int (1: success, 0: failure)Kein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
C++
Zugehöriger Quellcode · v0.1.6 · launch.hpp
Fehlerbehandlung: std::runtime_error; callback exceptions propagate; RAII; Status(): std::string JSON
Application::Connect
Application::Connect(origin, product, licentivo_product, trusted_keys_json, environment="live", remember=false, store=nullptr) → Application- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
merchantOrigin / origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.productID / product_id: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.licentivoProductID / licentivo_product_id: Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen.trustedKeys / trusted_keys: Zuordnung von Signaturschlüsselkennungen zu öffentlichen Schlüsseln zur Prüfung signierter SDK-Rechte.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.remember, store: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application::Login
Login(const char *email, const char *password) → void- Zweck
- Meldet das Kundenkonto an, holt eine kurzlebige Identitätsbestätigung und startet das offizielle Autorisierungs-SDK.
- Parameter
email, password: E-Mail und Passwort des Shop-Kundenkontos; Passwort nur für diese Anmeldung verwenden.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application::Restore
Restore() → bool- Zweck
- Liest die gespeicherte Sitzung, bestätigt das Konto online, holt eine neue Identitätsbestätigung und startet das offizielle SDK.
- Rückgabe
booltrue bedeutet wiederhergestellt; false bedeutet keine wiederherstellbare Sitzung. Ablehnung, Ablauf und Netzwerkfehler werden als Fehler gemeldet.
Application::RunFeature
RunFeature(const char *feature, Action action) → void- Zweck
- Das offizielle SDK prüft jede Ausführung. Der Rückruf wird nur mit Berechtigung ausgeführt.
- Parameter
feature / name, action / block: Der Funktionsname muss zur Richtlinie passen; der Rückruf enthält die tatsächlich geschützte Arbeit.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application::Logout
Logout() → void- Zweck
- Beendet lokale Autorisierung, meldet das offizielle SDK ab und widerruft die Launch-Sitzung. Offene Fernaufgaben bleiben zur Wiederholung erhalten.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application::ReleaseDevice
ReleaseDevice() → void- Zweck
- Kompatibilitätseinstieg zur ausdrücklichen Abmeldung mit demselben Konto- und Geräteablauf wie Logout.
- Rückgabe
voidKein Geschäftsrückgabewert; normaler Abschluss bedeutet Erfolg, Fehler oder Ausnahmen bedeuten Misserfolg.
Application::Status
Status() → std::string (JSON)- Zweck
- Liest den Autorisierungsstatus des offiziellen SDK, ohne Anmeldung oder Ersatz der Funktionsprüfung.
- Rückgabe
std::string (JSON)Liest den Autorisierungsstatus des offiziellen SDK, ohne Anmeldung oder Ersatz der Funktionsprüfung.
Application::~Application
~Application() → void- Zweck
- Stoppt diese Instanz und Hintergrundaufgaben; gespeicherte Anmeldung und Gerätebindung bleiben erhalten.
- Rückgabe
voidKein Geschäftsrückgabewert; normales Schließen bestätigt weder Kontoabmeldung noch Gerätefreigabe.
Erweiterte und Kompatibilitäts-APIs
Application
Application(origin, product, config, environment="live", remember=false, store=nullptr) → Application- Zweck
- Liest zwei vorhandene öffentliche Konfigurationen, prüft die Produktzuordnung und erstellt die Anwendung. Direktverbindungen benötigen keine Dateien.
- Parameter
origin: Vollständiger Shop-Ursprung mit Protokoll und nötigem Port; in Produktion HTTPS verwenden.product: Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt.config: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.environment: sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden.remember, store: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application(launch_application *)
explicit Application(launch_application *app) → Application- Zweck
- Prüft öffentliche Einstellungen und erstellt die Anwendung; meldet niemanden an und erlaubt keine geschützten Funktionen.
- Parameter
app: Liefert einen eigenen Anwendungszeiger; NULL bedeutet Initialisierungsfehler. Mit close freigeben.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application::FromFiles
Application::FromFiles(launch, product, remember=false, store=nullptr) → Application- Zweck
- Liest zwei vorhandene öffentliche Konfigurationen, prüft die Produktzuordnung und erstellt die Anwendung. Direktverbindungen benötigen keine Dateien.
- Parameter
launch, product: Gewählte Konfigurationspfade oder privates Cache- und Speicherverzeichnis des aktuellen Benutzers.remember, store: Optionen für Sitzungsspeicher, privaten Cache, Abbruch, Wiederholungen oder erweiterte Komponenten.
- Rückgabe
ApplicationLiefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Application(Application&&) / operator=
Application(Application&& other) / operator=(Application&& other) → Application / Application&- Zweck
- Überträgt den Besitz der nativen Anwendung. Kopieren ist deaktiviert; das ursprüngliche Objekt besitzt den Zeiger nicht mehr.
- Parameter
other: Konfiguration, Laufzeitadapter, Transport oder Anfrageobjekte nur für erweiterte Integrationen.
- Rückgabe
Application / Application&Liefert das erstellte Objekt; Initialisierung allein bedeutet keine Autorisierung.
Rückgabefelder
Liefert den Kontostatus; Feldbedeutungen stehen in der folgenden Tabelle.
| Feld | Typ | Zweck |
|---|---|---|
Go State.User.ID · JS user.id · Java userID · Rust user_id · Ruby user.id | string | Eindeutige Shop-Kontokennung, keine Produkt-, Lizenz- oder Gerätekennung. |
Go User.Email · JS user.email · Java/Rust/Ruby email | string | E-Mail des Shop-Kontos; einige Sprachzustände enthalten nur die Kontokennung. |
Go User.Verified / user.verified | boolean | Ob die Shop-E-Mail bestätigt ist; keine Softwareautorisierung. |
JS user.display_name | string (optional) | Anzeigename des Shop-Kontos; fehlt, wenn der Server ihn nicht liefert. |
Go State/Session.ExpiresAt · JS expiresAt · Java expiresAt · Rust/Ruby expires_at | time.Time / ISO 8601 / Instant | Ablauf der Launch-Kontositzung, kein Kaufablauf oder Offline-Autorisierungsende. |
Java offlineFallback · Rust offline_fallback | boolean = false | Kompatibilitätsfeld; aktuelle Kontowiederherstellung wählt keinen Offline-Rückfall, daher false. |
C / C++ status.allowed · C# Status().Allowed | boolean | Ob das offizielle SDK die Nutzung aktuell erlaubt; einzelne Funktionen separat prüfen. |
C / C++ status.state · C# Status().State | string | Statusname des offiziellen SDK; vor Anmeldung gegebenenfalls login_required. |
C / C++ status.code · C# Status().Code | string | Stabiler maschinenlesbarer Fehlercode für Meldungen und Behandlungszweige. |
C / C++ status.request_id · C# Status().RequestID | string | Server-Anfragekennung zur Diagnose; nicht in jeder Sprache verfügbar. |
C / C++ status.retryable · C# Status().Retryable | boolean | Ob ein neuer Versuch empfohlen wird; erlaubt keine aktuelle geschützte Ausführung. |
C / C++ status.lease_valid_until · C# Status().LeaseValidUntil | Unix seconds | Ablauf der signierten SDK-Berechtigung in Unix-Sekunden, getrennt vom Kontositzungsablauf. |
Go Identity.ProductID / product_id | UUID | Launch-Shop-Produktkennung, automatisch vom Integrationscode der Verwaltung ausgefüllt. |
Go Identity.LicentivoProductID / licentivo_product_id | UUID | Licentivo-Lizenzproduktkennung; muss zur öffentlichen Signaturkonfiguration passen. |
Go Identity.LaunchConnectionID / launch_connection_id | UUID | Festgelegte Launch-Verbindungskennung; muss zu Produkt und Umgebung passen. |
Go Identity.Environment / environment | sandbox | live | sandbox oder live; Konto, Produkte und Caches müssen dieselbe Umgebung verwenden. |
Go Identity.IdentityToken / identity_token | string | Kurzlebige einmalige Identitätsbestätigung im SDK-Arbeitsspeicher; keine Offline-Zugangsdaten. |
Go Identity.ExpiresAt / identity.expires_at | time.Time / ISO 8601 | Ablauf der Identitätsbestätigung, getrennt vom Ablauf der Kontositzung und des Kaufs. |
Go Session.AccessToken / access_token / token | string | Launch-Sitzungstoken, nur von Basissitzungs- oder verschlüsselten Speicherschnittstellen geliefert. |
Sitzungstoken, Identitätsbestätigungen und gespeicherte Datensätze sind geheim. Nicht protokollieren oder Browser-Renderern übergeben.
Fehlerbehandlung
| Feld | Typ | Zweck |
|---|---|---|
Go APIError.Code · Python APIError.code · C# Code · Java/Rust/Ruby code · JS code · C error() | string | Stabiler maschinenlesbarer Fehlercode für Meldungen und Behandlungszweige. |
Go APIError.Status · Python status · C# Status · Java/Rust/Ruby/JS status | integer | HTTP-Status; 0 bedeutet keine verfügbare HTTP-Antwort. |
Go RequestID · Java requestID · Rust request_id | string | Server-Anfragekennung zur Diagnose; nicht in jeder Sprache verfügbar. |
Go RetryAfter · Python retry_after · C# RetryAfterSeconds · Java retryAfterMillis · JS/Ruby retryAfterSeconds / retry_after_seconds · Rust retry_after | Duration / s / ms | Empfohlene Wartezeit; Sekunden, Millisekunden und Duration je Sprache unterscheiden. |
Lokale Abmeldung und Fernwiderruf sind getrennte Zustände. Offene Vorgänge und Speicherfehler behandeln; SDK-Abmeldeprotokoll erhalten.