Lewati ke konten

Fungsi dan nilai kembali SDK dalam sembilan bahasa

Lihat fungsi publik Launch, parameter, hasil, dan kegagalan menurut bahasa. Parameter opsional dan nilai bawaan mengikuti versi sumber yang sesuai.

Halaman ini menjelaskan adaptor akun Launch. Lihat referensi SDK resmi untuk API otorisasi, pengukuran, dan luring Licentivo.

Licentivo SDK · Referensi fungsi

Status sesi hanya menggambarkan akun; lindungi setiap eksekusi bisnis.

Penyimpanan bawaan memakai memori. Mengingat login memerlukan penyimpanan persisten terlindungi, terpisah dari cache SDK.

Pemulihan memerlukan konfirmasi akun daring. Launch tidak memilih izin luring akibat kegagalan jaringan; SDK resmi yang memverifikasinya.

Go

Sumber terkait · v0.1.6 · application.go · runtime.go · client.go · store.go

Kesalahan dan kegagalan: 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)
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • merchantOrigin / origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productID / product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • licentivoProductID / licentivo_product_id: ID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
  • trustedKeys / trusted_keys: Pemetaan ID kunci ke kunci publik untuk memverifikasi izin bertanda tangan SDK resmi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
(*Application, error)

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application.Login
Login(ctx context.Context, email, password string) → (State, error)
Kegunaan
Masuk dengan akun toko, memperoleh pernyataan identitas sementara, lalu memulai SDK otorisasi resmi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
  • email, password: Email dan kata sandi akun pelanggan toko ini; gunakan kata sandi hanya untuk login ini.
Nilai kembali
(State, error)

Mengembalikan status akun; lihat tabel bidang di bawah.

Application.Restore
Restore(ctx context.Context) → (State, error)
Kegunaan
Membaca sesi tersimpan, mengonfirmasi akun secara daring, memperoleh pernyataan baru, lalu memulai SDK resmi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
(State, error)

Mengembalikan status; ErrNoSession atau NO_SESSION berarti tidak ada sesi tersimpan. Tangani kesalahan lain secara terpisah.

Application.RunFeature
RunFeature(feature string, action func() error) → error
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
error

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application.Logout
Logout(ctx context.Context) → error
Kegunaan
Menghentikan otorisasi lokal, keluar melalui SDK resmi, lalu mencabut sesi Launch. Tugas jarak jauh yang tertunda disimpan untuk dicoba lagi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
error

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application.ReleaseDevice
ReleaseDevice(ctx context.Context) → error
Kegunaan
Pintu kompatibilitas untuk keluar eksplisit, dengan alur akun dan perangkat yang sama seperti Logout.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
error

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application.Close
Close() → void
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
void

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

API lanjutan dan kompatibilitas

NewApplication
NewApplication(config Config) → (*Application, error)
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
(*Application, error)

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

NewApplicationFromFiles
NewApplicationFromFiles(launchPath, productPath string, options Config) → (*Application, error)
Kegunaan
Membaca dua konfigurasi publik yang ada, memvalidasi pemetaan produk, lalu membuat aplikasi. Koneksi langsung tidak memerlukan berkas.
Parameter
  • launchPath, productPath: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
(*Application, error)

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

LoadPublicConfig
LoadPublicConfig(path string) → (PublicConfig, error)
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • path: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
(PublicConfig, error)

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

NewRuntime
NewRuntime(product ProductConfig, runtime RuntimeConfig) → (Runtime, error)
Kegunaan
Membuat adaptor SDK resmi untuk integrasi lanjutan; pernyataan identitas hanya diteruskan dalam memori.
Parameter
  • product, runtime: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
(Runtime, error)

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

New
New(origin string, allowLocalHTTP bool) → (*Client, error)
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • allowLocalHTTP: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
(*Client, error)

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Client.WithToken
WithToken(token string) → *Client
Kegunaan
Mengembalikan salinan klien dengan token akun yang diberikan, untuk backend tepercaya.
Parameter
  • token: Token sesi Launch, hanya dikembalikan oleh antarmuka sesi dasar atau penyimpanan terenkripsi.
Nilai kembali
*Client

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Client.Login
Login(ctx context.Context, email, password string) → (User, error)
Kegunaan
Mengautentikasi akun dan mengembalikan informasi atau sesi, tanpa memulai runtime otorisasi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
  • email, password: Email dan kata sandi akun pelanggan toko ini; gunakan kata sandi hanya untuk login ini.
Nilai kembali
(User, error)

Mengembalikan status akun; lihat tabel bidang di bawah.

Client.LoginSession
LoginSession(ctx context.Context, email, password string) → (Session, error)
Kegunaan
Mengautentikasi akun dan mengembalikan informasi atau sesi, tanpa memulai runtime otorisasi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
  • email, password: Email dan kata sandi akun pelanggan toko ini; gunakan kata sandi hanya untuk login ini.
Nilai kembali
(Session, error)

Mengembalikan status akun; lihat tabel bidang di bawah.

Client.CurrentUser
CurrentUser(ctx context.Context) → (User, error)
Kegunaan
Mengambil informasi akun saat ini; keberhasilan tidak mengizinkan fungsi terlindungi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
(User, error)

Mengembalikan status akun; lihat tabel bidang di bawah.

Client.Identity
Identity(ctx context.Context, product, environment string) → (Identity, error)
Kegunaan
Memperoleh pernyataan identitas sekali pakai dan konteks rute publik; bukan lisensi atau izin fitur.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
  • product: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
Nilai kembali
(Identity, error)

Mengembalikan status akun; lihat tabel bidang di bawah.

Client.SignOut
SignOut(ctx context.Context) → error
Kegunaan
Mencabut sesi Launch dan menghapus token klien; bukan pengganti keluar perangkat melalui SDK resmi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
error

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Client.Credential
Credential(ctx context.Context, product, environment string) → (Credential, error)
Kegunaan
API lama dipertahankan: protokol kredensial lisensi jangka panjang sudah dihapus sehingga panggilan gagal. Gunakan Application.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
  • product: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
Nilai kembali
(Credential, error)

Selalu gagal; migrasikan ke pertukaran identitas akun.

Client.CredentialWithRetry
CredentialWithRetry(ctx context.Context, product, environment string, policy RetryPolicy) → (Credential, error)
Kegunaan
API lama dipertahankan: protokol kredensial lisensi jangka panjang sudah dihapus sehingga panggilan gagal. Gunakan Application.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
  • product: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • policy: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
(Credential, error)

Selalu gagal; migrasikan ke pertukaran identitas akun.

NewSystemSessionStore
NewSystemSessionStore(directory string) → (SessionStore, error)
Kegunaan
Membuat penyimpanan persisten terlindungi; ambil kunci enkripsi dari brankas kredensial sistem operasi.
Parameter
  • directory: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
(SessionStore, error)

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

ProtectDirectory
ProtectDirectory(directory string) → error
Kegunaan
Membatasi akses direktori ke pengguna Windows saat ini atau izin privat pada platform lain.
Parameter
  • directory: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
error

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

ServiceUnavailable
ServiceUnavailable(err error) → bool
Kegunaan
Mengenali layanan yang sementara tidak tersedia; ini tidak pernah mengizinkan otorisasi luring.
Parameter
  • err: Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Nilai kembali
bool

Mengembalikan klasifikasi Boolean, bukan izin otorisasi.

APIError.Error / TransportError.Error
Error() → string
Kegunaan
Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Nilai kembali
string

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

TransportError.Unwrap
Unwrap() → error
Kegunaan
Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Nilai kembali
error

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

MemoryStore.Load / SessionStore.Load
Load(ctx context.Context, key string) → ([]byte, error)
Kegunaan
Memuat akun berdasarkan kunci terisolasi; data mengandung rahasia dan hanya untuk SDK.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
([]byte, error)

Mengembalikan rekaman rahasia; jika tidak ada, hasil kosong atau ErrNoSession sesuai bahasa.

MemoryStore.Save / SessionStore.Save
Save(ctx context.Context, key string, value []byte) → error
Kegunaan
Menyimpan akun secara atomik berdasarkan kunci terisolasi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
error

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

MemoryStore.Delete / SessionStore.Delete
Delete(ctx context.Context, key string) → error
Kegunaan
Menghapus akun tanpa menghapus cache otorisasi atau jurnal keluar SDK resmi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
error

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime.Start
Start(ctx context.Context, onError func(error)) → error
Kegunaan
Memulai verifikasi dan pemeliharaan SDK resmi; login dan pelindung fitur memakai API terpisah.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
  • onError: Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Nilai kembali
error

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime.RunFeature
RunFeature(feature string, action func() error) → error
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
error

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime.Deactivate
Deactivate(ctx context.Context) → error
Kegunaan
Keluar perangkat melalui SDK resmi; aplikasi mencabut sesi akun Launch secara terpisah.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
error

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime.Close
Close() → void
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
void

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

Python

Sumber terkait · v0.1.6 · client.py

Kesalahan dan kegagalan: 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
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • merchantOrigin / origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productID / product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • licentivoProductID / licentivo_product_id: ID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
  • trustedKeys / trusted_keys: Pemetaan ID kunci ke kunci publik untuk memverifikasi izin bertanda tangan SDK resmi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application.login
login(email, password, *, pending_attempts=3) → Application (self)
Kegunaan
Masuk dengan akun toko, memperoleh pernyataan identitas sementara, lalu memulai SDK otorisasi resmi.
Parameter
  • email, password: Email dan kata sandi akun pelanggan toko ini; gunakan kata sandi hanya untuk login ini.
  • pending_attempts: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application (self)

Mengembalikan instans aplikasi ini, bukan informasi akun atau hasil otorisasi.

Application.restore
restore() → bool
Kegunaan
Membaca sesi tersimpan, mengonfirmasi akun secara daring, memperoleh pernyataan baru, lalu memulai SDK resmi.
Nilai kembali
bool

true berarti pulih; false berarti tidak ada sesi yang dapat dipulihkan. Penolakan, kedaluwarsa, dan masalah jaringan menghasilkan kesalahan.

Application.run_feature
run_feature(name, action) → T
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
T

Mengembalikan hasil callback bisnis; kegagalan otorisasi atau pengecualian bisnis dilaporkan sebagai kesalahan.

Application.logout
logout() → bool
Kegunaan
Menghentikan otorisasi lokal, keluar melalui SDK resmi, lalu mencabut sesi Launch. Tugas jarak jauh yang tertunda disimpan untuk dicoba lagi.
Nilai kembali
bool

true mengonfirmasi keluar; false berarti keluar akun jarak jauh atau pencabutan perangkat masih tertunda. Penyimpanan juga dapat gagal.

Application.release_device
release_device() → bool
Kegunaan
Pintu kompatibilitas untuk keluar eksplisit, dengan alur akun dan perangkat yang sama seperti Logout.
Nilai kembali
bool

true mengonfirmasi keluar; false berarti keluar akun jarak jauh atau pencabutan perangkat masih tertunda. Penyimpanan juga dapat gagal.

Application.close
close() → None
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
None

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

Application.__enter__ / __exit__
with Application.connect(...) as app: ... → Application / None
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
Application / None

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

API lanjutan dan kompatibilitas

Application.__init__
Application(origin, product_id, product_config, environment="live", store=None, runtime_factory=None, cache_dir=None, sleep=time.sleep, opener=None) → Application
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • product_config: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application.from_files
Application.from_files(launch_config, product_config, **kwargs) → Application
Kegunaan
Membaca dua konfigurasi publik yang ada, memvalidasi pemetaan produk, lalu membuat aplikasi. Koneksi langsung tidak memerlukan berkas.
Parameter
  • launch_config, product_config: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

MemoryStore
MemoryStore() → MemoryStore
Kegunaan
Membuat penyimpanan sesi yang hanya berlaku dalam proses ini.
Nilai kembali
MemoryStore

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

WindowsDPAPIStore
WindowsDPAPIStore(directory=None) → WindowsDPAPIStore
Kegunaan
Membuat penyimpanan persisten terlindungi; ambil kunci enkripsi dari brankas kredensial sistem operasi.
Parameter
  • directory: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
WindowsDPAPIStore

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

APIError
APIError(code, status=0, retry_after=0) → APIError
Kegunaan
Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Parameter
  • code, status, retry_after: Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Nilai kembali
APIError

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

MemoryStore.load / WindowsDPAPIStore.load
load(key) → bytes | None
Kegunaan
Memuat akun berdasarkan kunci terisolasi; data mengandung rahasia dan hanya untuk SDK.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
bytes | None

Mengembalikan rekaman rahasia; jika tidak ada, hasil kosong atau ErrNoSession sesuai bahasa.

MemoryStore.save / WindowsDPAPIStore.save
save(key, value) → None
Kegunaan
Menyimpan akun secara atomik berdasarkan kunci terisolasi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
None

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

MemoryStore.delete / WindowsDPAPIStore.delete
delete(key) → None
Kegunaan
Menghapus akun tanpa menghapus cache otorisasi atau jurnal keluar SDK resmi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
None

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

C#

Sumber terkait · v0.1.6 · Application.cs · SessionStore.cs

Kesalahan dan kegagalan: 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
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • merchantOrigin / origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productID / product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • licentivoProductID / licentivo_product_id: ID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
  • trustedKeys / trusted_keys: Pemetaan ID kunci ke kunci publik untuk memverifikasi izin bertanda tangan SDK resmi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • store, cacheDirectory: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application.Login
Login(string email, string password, int pendingAttempts=3, CancellationToken ct=default) → Task
Kegunaan
Masuk dengan akun toko, memperoleh pernyataan identitas sementara, lalu memulai SDK otorisasi resmi.
Parameter
  • email, password: Email dan kata sandi akun pelanggan toko ini; gunakan kata sandi hanya untuk login ini.
  • pendingAttempts: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Task

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application.Restore
Restore(CancellationToken ct=default) → Task<bool>
Kegunaan
Membaca sesi tersimpan, mengonfirmasi akun secara daring, memperoleh pernyataan baru, lalu memulai SDK resmi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Task<bool>

true berarti pulih; false berarti tidak ada sesi yang dapat dipulihkan. Penolakan, kedaluwarsa, dan masalah jaringan menghasilkan kesalahan.

Application.RunFeature
RunFeature(string feature, Func<Task> action) → Task
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
Task

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application.Status
Status() → AuthorizationStatus? (null: runtime absent)
Kegunaan
Membaca status otorisasi SDK resmi; tidak melakukan login atau menggantikan pemeriksaan tiap fungsi.
Nilai kembali
AuthorizationStatus? (null: runtime absent)

Membaca status otorisasi SDK resmi; tidak melakukan login atau menggantikan pemeriksaan tiap fungsi.

Application.Logout
Logout(CancellationToken ct=default) → Task
Kegunaan
Menghentikan otorisasi lokal, keluar melalui SDK resmi, lalu mencabut sesi Launch. Tugas jarak jauh yang tertunda disimpan untuk dicoba lagi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Task

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application.ReleaseDevice
ReleaseDevice(CancellationToken ct=default) → Task
Kegunaan
Pintu kompatibilitas untuk keluar eksplisit, dengan alur akun dan perangkat yang sama seperti Logout.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Task

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application.DisposeAsync
DisposeAsync() → ValueTask
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
ValueTask

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

API lanjutan dan kompatibilitas

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
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productId: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • productConfig: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application.FromFiles
Application.FromFiles(string launchPath, string productPath, ISessionStore? store=null) → Application
Kegunaan
Membaca dua konfigurasi publik yang ada, memvalidasi pemetaan produk, lalu membuat aplikasi. Koneksi langsung tidak memerlukan berkas.
Parameter
  • launchPath, productPath: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • store: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

MemoryStore
new MemoryStore() → MemoryStore
Kegunaan
Membuat penyimpanan sesi yang hanya berlaku dalam proses ini.
Nilai kembali
MemoryStore

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

WindowsDPAPIStore
new WindowsDPAPIStore(string? directory=null) → WindowsDPAPIStore
Kegunaan
Membuat penyimpanan persisten terlindungi; ambil kunci enkripsi dari brankas kredensial sistem operasi.
Parameter
  • directory: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
WindowsDPAPIStore

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

LaunchException
new LaunchException(string code, int status=0, int retryAfterSeconds=0) → LaunchException
Kegunaan
Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Parameter
  • code, status, retryAfterSeconds: Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Nilai kembali
LaunchException

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

ISessionStore.Load / MemoryStore.Load / WindowsDPAPIStore.Load
Load(string key) → byte[]?
Kegunaan
Memuat akun berdasarkan kunci terisolasi; data mengandung rahasia dan hanya untuk SDK.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
byte[]?

Mengembalikan rekaman rahasia; jika tidak ada, hasil kosong atau ErrNoSession sesuai bahasa.

ISessionStore.Save / MemoryStore.Save / WindowsDPAPIStore.Save
Save(string key, byte[] value) → void
Kegunaan
Menyimpan akun secara atomik berdasarkan kunci terisolasi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

ISessionStore.Delete / MemoryStore.Delete / WindowsDPAPIStore.Delete
Delete(string key) → void
Kegunaan
Menghapus akun tanpa menghapus cache otorisasi atau jurnal keluar SDK resmi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

IRuntime.Start
Start(CancellationToken ct) → Task
Kegunaan
Memulai verifikasi dan pemeliharaan SDK resmi; login dan pelindung fitur memakai API terpisah.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Task

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

IRuntime.Status
Status() → AuthorizationStatus
Kegunaan
Membaca status otorisasi SDK resmi; tidak melakukan login atau menggantikan pemeriksaan tiap fungsi.
Nilai kembali
AuthorizationStatus

Membaca status otorisasi SDK resmi; tidak melakukan login atau menggantikan pemeriksaan tiap fungsi.

IRuntime.RunFeature
RunFeature(string feature, Func<Task> action) → Task
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
Task

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

IRuntime.Deactivate
Deactivate(CancellationToken ct) → Task
Kegunaan
Keluar perangkat melalui SDK resmi; aplikasi mencabut sesi akun Launch secara terpisah.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Task

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

IRuntime.DisposeAsync
DisposeAsync() → ValueTask
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
ValueTask

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

Java

Sumber terkait · v0.1.6 · Launch.java · EncryptedFileStore.java

Kesalahan dan kegagalan: 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
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • merchantOrigin / origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productID / product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • licentivoProductID / licentivo_product_id: ID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
  • trustedKeys / trusted_keys: Pemetaan ID kunci ke kunci publik untuk memverifikasi izin bertanda tangan SDK resmi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
Nilai kembali
Launch

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Launch.login
login(String email, char[] password) → State
Kegunaan
Masuk dengan akun toko, memperoleh pernyataan identitas sementara, lalu memulai SDK otorisasi resmi.
Parameter
  • email, password: Email dan kata sandi akun pelanggan toko ini; gunakan kata sandi hanya untuk login ini.
Nilai kembali
State

Mengembalikan status akun; lihat tabel bidang di bawah.

Launch.restore
restore() → State
Kegunaan
Membaca sesi tersimpan, mengonfirmasi akun secara daring, memperoleh pernyataan baru, lalu memulai SDK resmi.
Nilai kembali
State

Mengembalikan status; ErrNoSession atau NO_SESSION berarti tidak ada sesi tersimpan. Tangani kesalahan lain secara terpisah.

Launch.runFeature
runFeature(String feature, Client.FeatureAction action) → void
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Launch.logout
logout() → void
Kegunaan
Menghentikan otorisasi lokal, keluar melalui SDK resmi, lalu mencabut sesi Launch. Tugas jarak jauh yang tertunda disimpan untuk dicoba lagi.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Launch.releaseDevice
releaseDevice() → void
Kegunaan
Pintu kompatibilitas untuk keluar eksplisit, dengan alur akun dan perangkat yang sama seperti Logout.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Launch.close
close() → void
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
void

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

API lanjutan dan kompatibilitas

Launch
new Launch(Config config, Map<String,Object> product, Path cacheRoot [, Store store, Transport transport, RuntimeFactory factory, Sleeper sleeper]) → Launch
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • config, product: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
  • cacheRoot: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • store, transport, factory, sleeper: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Launch

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Launch.Config
new Launch.Config(String merchantOrigin, String launchProductID, String licentivoProductID, String environment) → Config
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • merchantOrigin / origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productID / product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • licentivoProductID / licentivo_product_id: ID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
Nilai kembali
Config

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

Launch.Config.load
Launch.Config.load(Path path) → Config
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • path: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
Config

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

Launch.readPublic
Launch.readPublic(Path path) → Map<String,Object>
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • path: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
Map<String,Object>

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

Launch.MemoryStore
new Launch.MemoryStore() → MemoryStore
Kegunaan
Membuat penyimpanan sesi yang hanya berlaku dalam proses ini.
Nilai kembali
MemoryStore

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

EncryptedFileStore
new EncryptedFileStore(Path directory, SecretKey vaultKey) → EncryptedFileStore
Kegunaan
Membuat penyimpanan persisten terlindungi; ambil kunci enkripsi dari brankas kredensial sistem operasi.
Parameter
  • directory: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • vaultKey: Kunci enkripsi dari brankas sistem operasi; jangan simpan bersama rekaman terenkripsi.
Nilai kembali
EncryptedFileStore

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Launch.HTTPTransport.request
request(String method, URI uri, String bearer, byte[] body) → Response
Kegunaan
Mengirim HTTP akun dan mengembalikan status, header, atau badan mentah, tanpa memutuskan otorisasi.
Parameter
  • method, uri, bearer, body: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
Response

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

Launch.Failure
new Launch.Failure(String code [, int status, String requestID, long retryAfterMillis, boolean transport]) → Failure
Kegunaan
Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Parameter
  • code, status, requestID, retryAfterMillis, transport: Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Nilai kembali
Failure

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

Launch.Failure.unavailable
unavailable() → boolean
Kegunaan
Mengenali layanan yang sementara tidak tersedia; ini tidak pernah mengizinkan otorisasi luring.
Nilai kembali
boolean

Mengembalikan klasifikasi Boolean, bukan izin otorisasi.

Store.load / MemoryStore.load / EncryptedFileStore.load
load(String scope) → byte[] | null
Kegunaan
Memuat akun berdasarkan kunci terisolasi; data mengandung rahasia dan hanya untuk SDK.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
byte[] | null

Mengembalikan rekaman rahasia; jika tidak ada, hasil kosong atau ErrNoSession sesuai bahasa.

Store.save / MemoryStore.save / EncryptedFileStore.save
save(String scope, byte[] secret) → void
Kegunaan
Menyimpan akun secara atomik berdasarkan kunci terisolasi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Store.delete / MemoryStore.delete / EncryptedFileStore.delete
delete(String scope) → void
Kegunaan
Menghapus akun tanpa menghapus cache otorisasi atau jurnal keluar SDK resmi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime.canStartOffline
canStartOffline() → boolean
Kegunaan
Membaca status otorisasi SDK resmi; tidak melakukan login atau menggantikan pemeriksaan tiap fungsi.
Nilai kembali
boolean

Mengembalikan klasifikasi Boolean, bukan izin otorisasi.

Runtime.start
start() → void
Kegunaan
Memulai verifikasi dan pemeliharaan SDK resmi; login dan pelindung fitur memakai API terpisah.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime.runFeature
runFeature(String feature, Client.FeatureAction action) → void
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime.releaseDevice
releaseDevice() → void
Kegunaan
Keluar perangkat melalui SDK resmi; aplikasi mencabut sesi akun Launch secara terpisah.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime.close
close() → void
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
void

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

RuntimeFactory.create
create(Map<String,Object> settings) → Runtime
Kegunaan
Membuat adaptor SDK resmi untuk integrasi lanjutan; pernyataan identitas hanya diteruskan dalam memori.
Parameter
  • settings: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
Runtime

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Sleeper.sleep
sleep(long milliseconds) → void
Kegunaan
Menunggu durasi yang ditentukan untuk penjadwalan percobaan ulang lanjutan.
Parameter
  • milliseconds: Waktu tunggu percobaan ulang; perhatikan perbedaan detik, milidetik, dan Duration antarbahasa.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

JavaScript / TypeScript

Sumber terkait · v0.1.6 · index.d.ts · index.mjs

Kesalahan dan kegagalan: await Promise; catch (error); LaunchError(code, status, retryAfterSeconds)

Application.connect
Application.connect(merchantOrigin, productID, licentivoProductID, trustedKeys, options?) → Application
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • merchantOrigin / origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productID / product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • licentivoProductID / licentivo_product_id: ID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
  • trustedKeys / trusted_keys: Pemetaan ID kunci ke kunci publik untuk memverifikasi izin bertanda tangan SDK resmi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application.login
login(email: string, password: string, options?: {signal?: AbortSignal}) → Promise<SessionState>
Kegunaan
Masuk dengan akun toko, memperoleh pernyataan identitas sementara, lalu memulai SDK otorisasi resmi.
Parameter
  • email, password: Email dan kata sandi akun pelanggan toko ini; gunakan kata sandi hanya untuk login ini.
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Promise<SessionState>

Mengembalikan status akun; lihat tabel bidang di bawah.

Application.restore
restore(options?: {signal?: AbortSignal}) → Promise<SessionState | null>
Kegunaan
Membaca sesi tersimpan, mengonfirmasi akun secara daring, memperoleh pernyataan baru, lalu memulai SDK resmi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Promise<SessionState | null>

Mengembalikan status akun; null atau nil berarti tidak ada sesi yang dapat dipulihkan. Kegagalan lain dilaporkan sebagai kesalahan.

Application.runFeature
runFeature<T>(name: string, action: () => T | Promise<T>) → Promise<T>
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
Promise<T>

Mengembalikan hasil callback bisnis; kegagalan otorisasi atau pengecualian bisnis dilaporkan sebagai kesalahan.

Application.logout
logout(options?: {signal?: AbortSignal}) → Promise<boolean>
Kegunaan
Menghentikan otorisasi lokal, keluar melalui SDK resmi, lalu mencabut sesi Launch. Tugas jarak jauh yang tertunda disimpan untuk dicoba lagi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Promise<boolean>

true mengonfirmasi keluar; false berarti keluar akun jarak jauh atau pencabutan perangkat masih tertunda. Penyimpanan juga dapat gagal.

Application.releaseDevice
releaseDevice(options?: {signal?: AbortSignal}) → Promise<void>
Kegunaan
Pintu kompatibilitas untuk keluar eksplisit, dengan alur akun dan perangkat yang sama seperti Logout.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Promise<void>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application.close
close() → Promise<void>
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
Promise<void>

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

API lanjutan dan kompatibilitas

Application
new Application(launch: LaunchConfig, product: PublicProductConfig, options?: Options) → Application
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • launch, product: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application.fromFiles
Application.fromFiles(launchPath: string, productPath: string, options?: Options) → Promise<Application>
Kegunaan
Membaca dua konfigurasi publik yang ada, memvalidasi pemetaan produk, lalu membuat aplikasi. Koneksi langsung tidak memerlukan berkas.
Parameter
  • launchPath, productPath: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Promise<Application>

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

validateConfig
validateConfig(launch: LaunchConfig, product: PublicProductConfig) → {launch: LaunchConfig, product: PublicProductConfig}
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • launch, product: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
{launch: LaunchConfig, product: PublicProductConfig}

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

loadConfig
loadConfig(launchPath: string, productPath: string) → Promise<{launch: LaunchConfig, product: PublicProductConfig}>
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • launchPath, productPath: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
Promise<{launch: LaunchConfig, product: PublicProductConfig}>

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

defaultTransport
defaultTransport(request: Request) → Promise<Response>
Kegunaan
Mengirim HTTP akun dan mengembalikan status, header, atau badan mentah, tanpa memutuskan otorisasi.
Parameter
  • request: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
Promise<Response>

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

MemoryStore
new MemoryStore() → MemoryStore
Kegunaan
Membuat penyimpanan sesi yang hanya berlaku dalam proses ini.
Nilai kembali
MemoryStore

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

EncryptedFileStore
new EncryptedFileStore(directory: string, key: Uint8Array) → EncryptedFileStore
Kegunaan
Membuat penyimpanan persisten terlindungi; ambil kunci enkripsi dari brankas kredensial sistem operasi.
Parameter
  • directory: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • key: Kunci enkripsi dari brankas sistem operasi; jangan simpan bersama rekaman terenkripsi.
Nilai kembali
EncryptedFileStore

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

LaunchError
new LaunchError(code: string, status=0, retryAfterSeconds=0) → LaunchError
Kegunaan
Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Parameter
  • code, status, retryAfterSeconds: Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Nilai kembali
LaunchError

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

SessionStore.load / MemoryStore.load / EncryptedFileStore.load
load(scope: string) → Promise<SavedSession | null>
Kegunaan
Memuat akun berdasarkan kunci terisolasi; data mengandung rahasia dan hanya untuk SDK.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
Promise<SavedSession | null>

Mengembalikan rekaman rahasia; jika tidak ada, hasil kosong atau ErrNoSession sesuai bahasa.

SessionStore.save / MemoryStore.save / EncryptedFileStore.save
save(scope: string, value: SavedSession) → Promise<void>
Kegunaan
Menyimpan akun secara atomik berdasarkan kunci terisolasi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
Promise<void>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

SessionStore.delete / MemoryStore.delete / EncryptedFileStore.delete
delete(scope: string) → Promise<void>
Kegunaan
Menghapus akun tanpa menghapus cache otorisasi atau jurnal keluar SDK resmi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
Promise<void>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime.status
status() → {allowed:boolean,state:string} | Promise<{allowed:boolean,state:string}>
Kegunaan
Membaca status otorisasi SDK resmi; tidak melakukan login atau menggantikan pemeriksaan tiap fungsi.
Nilai kembali
{allowed:boolean,state:string} | Promise<{allowed:boolean,state:string}>

Membaca status otorisasi SDK resmi; tidak melakukan login atau menggantikan pemeriksaan tiap fungsi.

Runtime.start
start(onError?: (error: unknown) => void, signal?: AbortSignal) → Promise<unknown>
Kegunaan
Memulai verifikasi dan pemeliharaan SDK resmi; login dan pelindung fitur memakai API terpisah.
Parameter
  • onError: Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Promise<unknown>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime.runFeature
runFeature<T>(name: string, action: () => T | Promise<T>) → Promise<T>
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
Promise<T>

Mengembalikan hasil callback bisnis; kegagalan otorisasi atau pengecualian bisnis dilaporkan sebagai kesalahan.

Runtime.deactivate
deactivate(signal?: AbortSignal) → Promise<unknown>
Kegunaan
Keluar perangkat melalui SDK resmi; aplikasi mencabut sesi akun Launch secara terpisah.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Promise<unknown>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime.logout
logout?(signal?: AbortSignal) → Promise<{local_complete:boolean,revocation_pending:boolean,storage_error?:string}>
Kegunaan
Keluar perangkat melalui SDK resmi; aplikasi mencabut sesi akun Launch secara terpisah.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Promise<{local_complete:boolean,revocation_pending:boolean,storage_error?:string}>

Keluar lokal dan pencabutan jarak jauh berbeda. Tangani tugas tertunda serta kegagalan penyimpanan dan pertahankan jurnal SDK.

Runtime.close
close() → Promise<unknown>
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
Promise<unknown>

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

Rust

Sumber terkait · v0.1.6 · lib.rs · store.rs · transport.rs

Kesalahan dan kegagalan: 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>
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • merchantOrigin / origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productID / product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • licentivoProductID / licentivo_product_id: ID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
  • trustedKeys / trusted_keys: Pemetaan ID kunci ke kunci publik untuk memverifikasi izin bertanda tangan SDK resmi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
Nilai kembali
Result<Application, Failure>

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application::login
login(&mut self, email: &str, password: &str) → Result<State, Failure>
Kegunaan
Masuk dengan akun toko, memperoleh pernyataan identitas sementara, lalu memulai SDK otorisasi resmi.
Parameter
  • email, password: Email dan kata sandi akun pelanggan toko ini; gunakan kata sandi hanya untuk login ini.
Nilai kembali
Result<State, Failure>

Mengembalikan status akun; lihat tabel bidang di bawah.

Application::restore
restore(&mut self) → Result<State, Failure>
Kegunaan
Membaca sesi tersimpan, mengonfirmasi akun secara daring, memperoleh pernyataan baru, lalu memulai SDK resmi.
Nilai kembali
Result<State, Failure>

Mengembalikan status; ErrNoSession atau NO_SESSION berarti tidak ada sesi tersimpan. Tangani kesalahan lain secara terpisah.

Application::run_feature
run_feature<T,F: FnOnce() -> Result<T,Failure>>(&mut self, feature: &str, action: F) → Result<T, Failure>
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
Result<T, Failure>

Mengembalikan hasil callback bisnis; kegagalan otorisasi atau pengecualian bisnis dilaporkan sebagai kesalahan.

Application::logout
logout(&mut self) → Result<(), Failure>
Kegunaan
Menghentikan otorisasi lokal, keluar melalui SDK resmi, lalu mencabut sesi Launch. Tugas jarak jauh yang tertunda disimpan untuk dicoba lagi.
Nilai kembali
Result<(), Failure>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application::release_device
release_device(&mut self) → Result<(), Failure>
Kegunaan
Pintu kompatibilitas untuk keluar eksplisit, dengan alur akun dan perangkat yang sama seperti Logout.
Nilai kembali
Result<(), Failure>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application::close / Drop
close(&mut self) / drop(&mut self) → ()
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
()

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

API lanjutan dan kompatibilitas

Application::new
Application::new(config: Config, product: Value, cache_root: PathBuf) → Result<Application, Failure>
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • config, product: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
  • cache_root: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
Result<Application, Failure>

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

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>
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • config, product: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
  • cache_root: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • store, transport, factory, sleeper: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Result<Application, Failure>

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Config::new
Config::new(origin: &str, product: &str, runtime_product: &str, environment: &str) → Result<Config, Failure>
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • merchantOrigin / origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productID / product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • licentivoProductID / licentivo_product_id: ID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
Nilai kembali
Result<Config, Failure>

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

Config::load
Config::load(path: impl AsRef<Path>) → Result<Config, Failure>
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • path: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
Result<Config, Failure>

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

read_public
read_public(path: impl AsRef<Path>) → Result<Value, Failure>
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • path: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
Result<Value, Failure>

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

MemoryStore::default
MemoryStore::default() → MemoryStore
Kegunaan
Membuat penyimpanan sesi yang hanya berlaku dalam proses ini.
Nilai kembali
MemoryStore

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

EncryptedFileStore::new
EncryptedFileStore::new(root: PathBuf, vault_key: [u8;32]) → Result<EncryptedFileStore, Failure>
Kegunaan
Membuat penyimpanan persisten terlindungi; ambil kunci enkripsi dari brankas kredensial sistem operasi.
Parameter
  • root: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • vault_key: Kunci enkripsi dari brankas sistem operasi; jangan simpan bersama rekaman terenkripsi.
Nilai kembali
Result<EncryptedFileStore, Failure>

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

CurlTransport::new
CurlTransport::new() → Result<CurlTransport, Failure>
Kegunaan
Mengirim HTTP akun dan mengembalikan status, header, atau badan mentah, tanpa memutuskan otorisasi.
Nilai kembali
Result<CurlTransport, Failure>

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

CurlTransport::request
request(&mut self, method: &str, url: &str, bearer: &str, body: &[u8]) → Result<Response, Failure>
Kegunaan
Mengirim HTTP akun dan mengembalikan status, header, atau badan mentah, tanpa memutuskan otorisasi.
Parameter
  • method, url, bearer, body: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
Result<Response, Failure>

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

Failure::new
Failure::new(code: &str) → Failure
Kegunaan
Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Parameter
  • code: Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Nilai kembali
Failure

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

ThreadSleeper::sleep
sleep(&mut self, duration: Duration) → Result<(), Failure>
Kegunaan
Menunggu durasi yang ditentukan untuk penjadwalan percobaan ulang lanjutan.
Parameter
  • duration: Waktu tunggu percobaan ulang; perhatikan perbedaan detik, milidetik, dan Duration antarbahasa.
Nilai kembali
Result<(), Failure>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Store::load / MemoryStore::load / EncryptedFileStore::load
load(&mut self, scope: &str) → Result<Option<Vec<u8>>, Failure>
Kegunaan
Memuat akun berdasarkan kunci terisolasi; data mengandung rahasia dan hanya untuk SDK.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
Result<Option<Vec<u8>>, Failure>

Mengembalikan rekaman rahasia; jika tidak ada, hasil kosong atau ErrNoSession sesuai bahasa.

Store::save / MemoryStore::save / EncryptedFileStore::save
save(&mut self, scope: &str, value: &[u8]) → Result<(), Failure>
Kegunaan
Menyimpan akun secara atomik berdasarkan kunci terisolasi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
Result<(), Failure>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Store::delete / MemoryStore::delete / EncryptedFileStore::delete
delete(&mut self, scope: &str) → Result<(), Failure>
Kegunaan
Menghapus akun tanpa menghapus cache otorisasi atau jurnal keluar SDK resmi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
Result<(), Failure>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime::run_feature
run_feature(&mut self, feature: &str, action: &mut dyn FnMut() -> Result<(),Failure>) → Result<(), Failure>
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
Result<(), Failure>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime::release_device
release_device(&mut self) → Result<(), Failure>
Kegunaan
Keluar perangkat melalui SDK resmi; aplikasi mencabut sesi akun Launch secara terpisah.
Nilai kembali
Result<(), Failure>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Runtime::close
close(&mut self) → ()
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
()

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

RuntimeFactory::open / OfficialRuntimeFactory::open
open(&mut self, settings: &Value, cached_only: bool) → Result<Box<dyn Runtime>, Failure>
Kegunaan
Membuat adaptor SDK resmi untuk integrasi lanjutan; pernyataan identitas hanya diteruskan dalam memori.
Parameter
  • settings, cached_only: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
Result<Box<dyn Runtime>, Failure>

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

RuntimeFactory::for_logout / OfficialRuntimeFactory::for_logout
for_logout(&mut self, settings: &Value) → Result<Box<dyn Runtime>, Failure>
Kegunaan
Membuat adaptor SDK resmi untuk integrasi lanjutan; pernyataan identitas hanya diteruskan dalam memori.
Parameter
  • settings: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
Result<Box<dyn Runtime>, Failure>

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Sleeper::sleep
sleep(&mut self, duration: Duration) → Result<(), Failure>
Kegunaan
Menunggu durasi yang ditentukan untuk penjadwalan percobaan ulang lanjutan.
Parameter
  • duration: Waktu tunggu percobaan ulang; perhatikan perbedaan detik, milidetik, dan Duration antarbahasa.
Nilai kembali
Result<(), Failure>

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Ruby

Sumber terkait · v0.1.6 · licentivo_launch.rb

Kesalahan dan kegagalan: 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
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • merchantOrigin / origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productID / product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • licentivoProductID / licentivo_product_id: ID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
  • trustedKeys / trusted_keys: Pemetaan ID kunci ke kunci publik untuk memverifikasi izin bertanda tangan SDK resmi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application#login
login(email, password, cancellation: nil) → Hash
Kegunaan
Masuk dengan akun toko, memperoleh pernyataan identitas sementara, lalu memulai SDK otorisasi resmi.
Parameter
  • email, password: Email dan kata sandi akun pelanggan toko ini; gunakan kata sandi hanya untuk login ini.
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Hash

Mengembalikan status akun; lihat tabel bidang di bawah.

Application#restore
restore(cancellation: nil) → Hash | nil
Kegunaan
Membaca sesi tersimpan, mengonfirmasi akun secara daring, memperoleh pernyataan baru, lalu memulai SDK resmi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
Hash | nil

Mengembalikan status akun; null atau nil berarti tidak ada sesi yang dapat dipulihkan. Kegagalan lain dilaporkan sebagai kesalahan.

Application#run_feature
run_feature(feature) { ... } → T
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
T

Mengembalikan hasil callback bisnis; kegagalan otorisasi atau pengecualian bisnis dilaporkan sebagai kesalahan.

Application#logout
logout(cancellation: nil) → true | false
Kegunaan
Menghentikan otorisasi lokal, keluar melalui SDK resmi, lalu mencabut sesi Launch. Tugas jarak jauh yang tertunda disimpan untuk dicoba lagi.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
true | false

true mengonfirmasi keluar; false berarti keluar akun jarak jauh atau pencabutan perangkat masih tertunda. Penyimpanan juga dapat gagal.

Application#release_device
release_device(cancellation: nil) → true | false
Kegunaan
Pintu kompatibilitas untuk keluar eksplisit, dengan alur akun dan perangkat yang sama seperti Logout.
Parameter
  • ctx / ct / signal / cancellation: Konteks permintaan atau sinyal pembatalan; konteks siklus hidup Go juga mengontrol tugas latar.
Nilai kembali
true | false

true mengonfirmasi keluar; false berarti keluar akun jarak jauh atau pencabutan perangkat masih tertunda. Penyimpanan juga dapat gagal.

Application#close
close → nil
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
nil

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

API lanjutan dan kompatibilitas

Application.new
Application.new(launch, product, store: MemoryStore.new, transport: nil, runtime_factory: nil, cache_dir: nil, sleep: nil, pending_attempts: 5) → Application
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • launch, product: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application.from_files
Application.from_files(launch_path, product_path, **options) → Application
Kegunaan
Membaca dua konfigurasi publik yang ada, memvalidasi pemetaan produk, lalu membuat aplikasi. Koneksi langsung tidak memerlukan berkas.
Parameter
  • launchPath, productPath: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • options / config: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

LicentivoLaunch.origin
LicentivoLaunch.origin(value, environment) → String
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • value: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
Nilai kembali
String

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

LicentivoLaunch.validate_config
LicentivoLaunch.validate_config(launch, product) → [Hash, Hash]
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • launch, product: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
[Hash, Hash]

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

LicentivoLaunch.load_config
LicentivoLaunch.load_config(launch_path, product_path) → [Hash, Hash]
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • launchPath, productPath: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
Nilai kembali
[Hash, Hash]

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

LicentivoLaunch.default_transport
LicentivoLaunch.default_transport(request) → Hash
Kegunaan
Mengirim HTTP akun dan mengembalikan status, header, atau badan mentah, tanpa memutuskan otorisasi.
Parameter
  • request: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
Hash

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

MemoryStore.new
MemoryStore.new → MemoryStore
Kegunaan
Membuat penyimpanan sesi yang hanya berlaku dalam proses ini.
Nilai kembali
MemoryStore

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

EncryptedFileStore.new
EncryptedFileStore.new(directory, key) → EncryptedFileStore
Kegunaan
Membuat penyimpanan persisten terlindungi; ambil kunci enkripsi dari brankas kredensial sistem operasi.
Parameter
  • directory: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • key: Kunci enkripsi dari brankas sistem operasi; jangan simpan bersama rekaman terenkripsi.
Nilai kembali
EncryptedFileStore

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

MemoryStore#persistent? / EncryptedFileStore#persistent? / #secure?
persistent? / secure? → true | false
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Nilai kembali
true | false

Mengembalikan klasifikasi Boolean, bukan izin otorisasi.

EncryptedFileStore#path
path(scope) → String
Kegunaan
Memvalidasi atau membaca konfigurasi publik; ID produk, lingkungan, dan kunci tanda tangan harus cocok.
Parameter
  • scope: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
String

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

CancellationToken#cancel / #check!
CancellationToken.new.cancel / check! → true / nil
Kegunaan
Meminta atau memeriksa pembatalan kooperatif; pembatalan bukan keberhasilan otorisasi.
Nilai kembali
true / nil

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Error.new
Error.new(code, status: 0, retry_after_seconds: 0) → Error
Kegunaan
Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Parameter
  • code, status, retry_after_seconds: Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Nilai kembali
Error

Mengembalikan tipe nilai pada tanda tangan; hasilnya sendiri tidak memberi izin fitur.

MemoryStore#load / EncryptedFileStore#load
load(scope) → Hash | nil
Kegunaan
Memuat akun berdasarkan kunci terisolasi; data mengandung rahasia dan hanya untuk SDK.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
Hash | nil

Mengembalikan rekaman rahasia; jika tidak ada, hasil kosong atau ErrNoSession sesuai bahasa.

MemoryStore#save / EncryptedFileStore#save
save(scope, record) → Object
Kegunaan
Menyimpan akun secara atomik berdasarkan kunci terisolasi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
Object

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

MemoryStore#delete / EncryptedFileStore#delete
delete(scope) → Object
Kegunaan
Menghapus akun tanpa menghapus cache otorisasi atau jurnal keluar SDK resmi.
Parameter
  • scope / key, value / record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
Object

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

C

Sumber terkait · v0.1.6 · account.h · account.c

Kesalahan dan kegagalan: 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 *
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • merchantOrigin / origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productID / product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • licentivoProductID / licentivo_product_id: ID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
  • trustedKeys / trusted_keys: Pemetaan ID kunci ke kunci publik untuk memverifikasi izin bertanda tangan SDK resmi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • remember, store: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
launch_application *

Mengembalikan pointer aplikasi milik pemanggil; NULL berarti inisialisasi gagal. Lepaskan dengan close.

launch_application_login
launch_application_login(launch_application *app, const char *email, const char *password) → int
Kegunaan
Masuk dengan akun toko, memperoleh pernyataan identitas sementara, lalu memulai SDK otorisasi resmi.
Parameter
  • email, password: Email dan kata sandi akun pelanggan toko ini; gunakan kata sandi hanya untuk login ini.
Nilai kembali
int

1 berarti berhasil; 0 berarti gagal. Baca kode kesalahan setelah gagal.

launch_application_restore
launch_application_restore(launch_application *app) → int
Kegunaan
Membaca sesi tersimpan, mengonfirmasi akun secara daring, memperoleh pernyataan baru, lalu memulai SDK resmi.
Nilai kembali
int

1 berarti pulih, 0 tanpa sesi, -1 ditolak atau gagal. Baca kode kesalahan setelah gagal.

launch_application_run_feature
launch_application_run_feature(app, feature, ln_feature_action action, void *context) → int
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
  • context: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
int

1 berarti berhasil; 0 berarti gagal. Baca kode kesalahan setelah gagal.

launch_application_logout
launch_application_logout(launch_application *app) → int
Kegunaan
Menghentikan otorisasi lokal, keluar melalui SDK resmi, lalu mencabut sesi Launch. Tugas jarak jauh yang tertunda disimpan untuk dicoba lagi.
Nilai kembali
int

1 berarti berhasil; 0 berarti gagal. Baca kode kesalahan setelah gagal.

launch_application_release_device
launch_application_release_device(launch_application *app) → int
Kegunaan
Pintu kompatibilitas untuk keluar eksplisit, dengan alur akun dan perangkat yang sama seperti Logout.
Nilai kembali
int

1 berarti berhasil; 0 berarti gagal. Baca kode kesalahan setelah gagal.

launch_application_status
launch_application_status(launch_application *app) → char *
Kegunaan
Membaca status otorisasi SDK resmi; tidak melakukan login atau menggantikan pemeriksaan tiap fungsi.
Nilai kembali
char *

Mengembalikan JSON milik pemanggil; bebaskan dengan ln_free_string. Tanpa runtime: login_required dan allowed=false.

launch_application_error
launch_application_error(const launch_application *app) → const char *
Kegunaan
Membuat atau membaca kesalahan terstruktur untuk klasifikasi, penundaan, dan diagnosis terkait.
Nilai kembali
const char *

Mengembalikan string kode kesalahan pinjaman. Jangan bebaskan atau akses setelah aplikasi dihancurkan.

launch_application_close
launch_application_close(launch_application *app) → void
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
void

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

API lanjutan dan kompatibilitas

launch_application_open
launch_application_open(origin, product_id, product_config_path, environment, remember, store) → launch_application *
Kegunaan
Membaca dua konfigurasi publik yang ada, memvalidasi pemetaan produk, lalu membuat aplikasi. Koneksi langsung tidak memerlukan berkas.
Parameter
  • origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • product_config_path: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • remember, store: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
launch_application *

Mengembalikan pointer aplikasi milik pemanggil; NULL berarti inisialisasi gagal. Lepaskan dengan close.

launch_application_from_files
launch_application_from_files(launch_config_path, product_config_path, remember, store) → launch_application *
Kegunaan
Membaca dua konfigurasi publik yang ada, memvalidasi pemetaan produk, lalu membuat aplikasi. Koneksi langsung tidak memerlukan berkas.
Parameter
  • launchPath, productPath: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • remember, store: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
launch_application *

Mengembalikan pointer aplikasi milik pemanggil; NULL berarti inisialisasi gagal. Lepaskan dengan close.

launch_application_cli
launch_application_cli(int argc, char **argv) → launch_application *
Kegunaan
Membaca dua konfigurasi publik yang ada, memvalidasi pemetaan produk, lalu membuat aplikasi. Koneksi langsung tidak memerlukan berkas.
Parameter
  • argc, argv: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
launch_application *

Mengembalikan pointer aplikasi milik pemanggil; NULL berarti inisialisasi gagal. Lepaskan dengan close.

launch_login / launch_sign_in
launch_login(account, origin, product_id, config_path, environment, email, password) / launch_sign_in(account, argc, argv) → int
Kegunaan
API lama dipertahankan: protokol kredensial lisensi jangka panjang sudah dihapus sehingga panggilan gagal. Gunakan Application.
Parameter
  • account, origin, product_id, config_path, environment, email, password, argc, argv: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
int

Selalu gagal; migrasikan ke pertukaran identitas akun.

launch_sign_out
launch_sign_out(launch_account *account, int clear_cache) → void
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Parameter
  • account, clear_cache: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

ln_free_string
ln_free_string(char *value) → void
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Parameter
  • value: Mengembalikan JSON milik pemanggil; bebaskan dengan ln_free_string. Tanpa runtime: login_required dan allowed=false.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

launch_secret_store.load
load(void *context, const char *scope, char **record) → int
Kegunaan
Memuat akun berdasarkan kunci terisolasi; data mengandung rahasia dan hanya untuk SDK.
Parameter
  • context: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
  • scope, record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
int

1 ditemukan, 0 tidak ada, -1 gagal dibaca. load mengalokasikan record; pemanggil membebaskannya.

launch_secret_store.save
save(void *context, const char *scope, const char *record) → int (1: success, 0: failure)
Kegunaan
Menyimpan akun secara atomik berdasarkan kunci terisolasi.
Parameter
  • context: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
  • scope, record: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
int (1: success, 0: failure)

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

launch_secret_store.remove
remove(void *context, const char *scope) → int (1: success, 0: failure)
Kegunaan
Menghapus akun tanpa menghapus cache otorisasi atau jurnal keluar SDK resmi.
Parameter
  • context: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
  • scope: Kunci isolasi serta rekaman rahasia SDK; penyimpanan khusus wajib mendukung banyak kunci dan penggantian atomik.
Nilai kembali
int (1: success, 0: failure)

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

C++

Sumber terkait · v0.1.6 · launch.hpp

Kesalahan dan kegagalan: 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
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • merchantOrigin / origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • productID / product_id: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • licentivoProductID / licentivo_product_id: ID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
  • trustedKeys / trusted_keys: Pemetaan ID kunci ke kunci publik untuk memverifikasi izin bertanda tangan SDK resmi.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • remember, store: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application::Login
Login(const char *email, const char *password) → void
Kegunaan
Masuk dengan akun toko, memperoleh pernyataan identitas sementara, lalu memulai SDK otorisasi resmi.
Parameter
  • email, password: Email dan kata sandi akun pelanggan toko ini; gunakan kata sandi hanya untuk login ini.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application::Restore
Restore() → bool
Kegunaan
Membaca sesi tersimpan, mengonfirmasi akun secara daring, memperoleh pernyataan baru, lalu memulai SDK resmi.
Nilai kembali
bool

true berarti pulih; false berarti tidak ada sesi yang dapat dipulihkan. Penolakan, kedaluwarsa, dan masalah jaringan menghasilkan kesalahan.

Application::RunFeature
RunFeature(const char *feature, Action action) → void
Kegunaan
SDK resmi memeriksa izin setiap eksekusi. Callback hanya dijalankan jika diizinkan.
Parameter
  • feature / name, action / block: Nama fitur harus cocok dengan kebijakan; callback berisi pekerjaan terlindungi yang sesungguhnya.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application::Logout
Logout() → void
Kegunaan
Menghentikan otorisasi lokal, keluar melalui SDK resmi, lalu mencabut sesi Launch. Tugas jarak jauh yang tertunda disimpan untuk dicoba lagi.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application::ReleaseDevice
ReleaseDevice() → void
Kegunaan
Pintu kompatibilitas untuk keluar eksplisit, dengan alur akun dan perangkat yang sama seperti Logout.
Nilai kembali
void

Tanpa nilai bisnis; selesai normal berarti berhasil, sedangkan kesalahan atau pengecualian berarti gagal.

Application::Status
Status() → std::string (JSON)
Kegunaan
Membaca status otorisasi SDK resmi; tidak melakukan login atau menggantikan pemeriksaan tiap fungsi.
Nilai kembali
std::string (JSON)

Membaca status otorisasi SDK resmi; tidak melakukan login atau menggantikan pemeriksaan tiap fungsi.

Application::~Application
~Application() → void
Kegunaan
Menghentikan instans dan tugas latar, sambil mempertahankan login tersimpan dan ikatan perangkat.
Nilai kembali
void

Tanpa nilai bisnis; penutupan biasa tidak mengonfirmasi keluar akun atau pelepasan perangkat.

API lanjutan dan kompatibilitas

Application
Application(origin, product, config, environment="live", remember=false, store=nullptr) → Application
Kegunaan
Membaca dua konfigurasi publik yang ada, memvalidasi pemetaan produk, lalu membuat aplikasi. Koneksi langsung tidak memerlukan berkas.
Parameter
  • origin: Origin lengkap toko, termasuk protokol dan port yang diperlukan; gunakan HTTPS dalam produksi.
  • product: ID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
  • config: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • environment: sandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
  • remember, store: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application(launch_application *)
explicit Application(launch_application *app) → Application
Kegunaan
Memvalidasi konfigurasi publik dan membuat aplikasi; belum masuk akun atau mengizinkan fungsi terlindungi.
Parameter
  • app: Mengembalikan pointer aplikasi milik pemanggil; NULL berarti inisialisasi gagal. Lepaskan dengan close.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application::FromFiles
Application::FromFiles(launch, product, remember=false, store=nullptr) → Application
Kegunaan
Membaca dua konfigurasi publik yang ada, memvalidasi pemetaan produk, lalu membuat aplikasi. Koneksi langsung tidak memerlukan berkas.
Parameter
  • launch, product: Jalur konfigurasi pilihan pemanggil atau direktori cache dan penyimpanan privat pengguna saat ini.
  • remember, store: Opsi penyimpanan sesi, direktori cache privat, pembatalan, percobaan ulang, atau komponen lanjutan.
Nilai kembali
Application

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Application(Application&&) / operator=
Application(Application&& other) / operator=(Application&& other) → Application / Application&
Kegunaan
Memindahkan kepemilikan aplikasi native. Penyalinan dinonaktifkan dan objek asal tidak lagi memiliki pointer.
Parameter
  • other: Objek konfigurasi, adaptor runtime, transportasi, atau permintaan hanya untuk integrasi lanjutan.
Nilai kembali
Application / Application&

Mengembalikan objek yang dibuat; inisialisasi saja bukan bukti otorisasi.

Bidang hasil

Mengembalikan status akun; lihat tabel bidang di bawah.

KolomJenisKegunaan
Go State.User.ID · JS user.id · Java userID · Rust user_id · Ruby user.idstringID unik akun toko, bukan ID produk, lisensi, atau perangkat.
Go User.Email · JS user.email · Java/Rust/Ruby emailstringEmail akun toko; beberapa bahasa hanya menyertakan ID akun dalam status.
Go User.Verified / user.verifiedbooleanApakah email toko sudah diverifikasi; bukan status otorisasi perangkat lunak.
JS user.display_namestring (optional)Nama tampilan akun toko; dihilangkan jika server tidak menyediakannya.
Go State/Session.ExpiresAt · JS expiresAt · Java expiresAt · Rust/Ruby expires_attime.Time / ISO 8601 / InstantKedaluwarsa sesi akun Launch, bukan kedaluwarsa pembelian atau batas otorisasi luring.
Java offlineFallback · Rust offline_fallbackboolean = falseBidang kompatibilitas; pemulihan akun saat ini tidak memilih fallback luring, jadi nilainya false.
C / C++ status.allowed · C# Status().AllowedbooleanApakah SDK resmi mengizinkan penggunaan saat ini; periksa fitur secara terpisah.
C / C++ status.state · C# Status().StatestringNama status SDK resmi; login_required dapat muncul sebelum masuk.
C / C++ status.code · C# Status().CodestringKode kesalahan mesin stabil untuk pesan dan cabang penanganan.
C / C++ status.request_id · C# Status().RequestIDstringID korelasi permintaan server untuk diagnosis; tidak tersedia dalam setiap bahasa.
C / C++ status.retryable · C# Status().RetryablebooleanApakah percobaan ulang disarankan; bukan izin untuk menjalankan pekerjaan terlindungi sekarang.
C / C++ status.lease_valid_until · C# Status().LeaseValidUntilUnix secondsKedaluwarsa izin bertanda tangan SDK dalam detik Unix, terpisah dari kedaluwarsa sesi akun.
Go Identity.ProductID / product_idUUIDID produk toko Launch, diisi otomatis oleh kode integrasi administrasi.
Go Identity.LicentivoProductID / licentivo_product_idUUIDID produk lisensi Licentivo, harus cocok dengan konfigurasi tanda tangan publik.
Go Identity.LaunchConnectionID / launch_connection_idUUIDID koneksi lisensi Launch yang disematkan; harus cocok dengan produk dan lingkungan.
Go Identity.Environment / environmentsandbox | livesandbox atau live; akun, produk, dan cache harus berada dalam lingkungan yang sama.
Go Identity.IdentityToken / identity_tokenstringPernyataan identitas sementara sekali pakai dalam memori SDK resmi; tidak boleh menjadi kredensial luring.
Go Identity.ExpiresAt / identity.expires_attime.Time / ISO 8601Kedaluwarsa pernyataan identitas, bukan sesi akun atau masa pembelian.
Go Session.AccessToken / access_token / tokenstringToken sesi Launch, hanya dikembalikan oleh antarmuka sesi dasar atau penyimpanan terenkripsi.

Token, pernyataan identitas, dan rekaman tersimpan bersifat rahasia. Jangan masukkan ke log atau perender browser.

Kesalahan dan kegagalan

KolomJenisKegunaan
Go APIError.Code · Python APIError.code · C# Code · Java/Rust/Ruby code · JS code · C error()stringKode kesalahan mesin stabil untuk pesan dan cabang penanganan.
Go APIError.Status · Python status · C# Status · Java/Rust/Ruby/JS statusintegerStatus HTTP; 0 berarti tidak ada respons HTTP yang tersedia.
Go RequestID · Java requestID · Rust request_idstringID korelasi permintaan server untuk diagnosis; tidak tersedia dalam setiap bahasa.
Go RetryAfter · Python retry_after · C# RetryAfterSeconds · Java retryAfterMillis · JS/Ruby retryAfterSeconds / retry_after_seconds · Rust retry_afterDuration / s / msWaktu tunggu percobaan ulang; perhatikan perbedaan detik, milidetik, dan Duration antarbahasa.

Keluar lokal dan pencabutan jarak jauh berbeda. Tangani tugas tertunda serta kegagalan penyimpanan dan pertahankan jurnal SDK.