Activates this plugin installation with an Inlay license key.
Accepts either an offline Ed25519 key or a platform key. The key is tried as an offline key first; if that fails and the key looks like a platform key, it is registered and activated against the licensing service. Activation persists across restarts and is observed by the next function call immediately.
Declaration
Inlay_REGISTER_LICENSE("INLAY-XXXX-XXXX-XXXX")
Parameters
Key
Required
the license key string. Leading and trailing whitespace is trimmed.
Returns
JSON string
On success returns {"status":true,"version":...,"source":"offline"|"platform",...}. An offline activation also returns name, email, expires, and licensee. A platform activation also returns licensed, installation_id, grace_days, and last_successful_contact_secs. On failure returns {"status":false,"version":...,"message":"..."}.
Use Cases
Activate the plugin from a startup script before any licensed function runs.
Re-key a workstation after moving to a new platform seat or offline key.
Notes
Offline keys carry their own expiry; an expired key is rejected at activation.
Platform keys consume a seat. Use Inlay_DEACTIVATE to release the seat before re-keying elsewhere.
Reports the current license and activation state as JSON.
Checks the active offline license first, then the platform activation. Use it to gate scripts and to display license state in your solution UI. Takes no arguments.
Declaration
Inlay_LICENSE_STATUS
This function takes no parameters.
Returns
JSON string
When an offline license is active: {"status":true,"licensed":true,"source":"offline","name":...,"email":...,"expires":...,"licensee":...,"expired":...}. When a platform activation is allowed: {"status":true,"licensed":true,"source":"platform","installation_id":...,"grace_days":...,"last_successful_contact_secs":...,"last_error_message":...}. When unlicensed: {"status":false,"licensed":false,"source":"none","platform_key_registered":...,"last_error_message":...}. All responses include version.
Use Cases
Branch a startup script on licensed to decide whether to prompt for activation.
Surface expires or grace_days in an admin layout so users renew before lockout.
Notes
Read the licensed boolean rather than status to gate features; status reflects whether the call succeeded.
source distinguishes an offline key from a platform seat.
Fully deactivates this plugin installation, locally and online.
Releases the platform seat remotely when one is present, removes any registered license key from local storage (platform token or offline Ed25519 key), and invalidates the in-memory license cache so the next function call observes the unlicensed state immediately. No plugin restart is required. Takes no arguments.
Declaration
Inlay_DEACTIVATE
This function takes no parameters.
Returns
JSON string
On success returns {"status":true,"version":...,"source":"plugin","message":"deactivated","platform_seat_found":...,"remote_deactivated":...,"local_key_cleared":...}. On failure returns {"status":false,"version":...,"source":"plugin","message":"..."}.
Use Cases
Release a platform seat before moving the license to another workstation.
Clear a stored key during decommissioning or support troubleshooting.
Notes
Covers both offline and platform licenses; the previous name Inlay_PLATFORM_DEACTIVATE understated this scope.
platform_seat_found and remote_deactivated are false when no online seat was present, which is normal for offline-only installs.
Deprecated alias for Inlay_DEACTIVATE, kept for one release cycle.
Behaves identically to Inlay_DEACTIVATE: it releases any platform seat, clears the locally stored key (platform or offline), and invalidates the in-memory cache. The name is preserved only so existing scripts parse and run after the 0.2.6 rename. Scheduled for removal in 0.2.7. Update scripts to call Inlay_DEACTIVATE. Takes no arguments.
Declaration
Inlay_PLATFORM_DEACTIVATE
This function takes no parameters.
Returns
JSON string
Same shape as Inlay_DEACTIVATE, plus {"deprecated":true,"deprecation_note":"Inlay_PLATFORM_DEACTIVATE is deprecated; use Inlay_DEACTIVATE"} so usage can be spotted in logs. On success: {"status":true,"version":...,"source":"plugin","message":"deactivated","deprecated":true,"deprecation_note":...,"platform_seat_found":...,"remote_deactivated":...,"local_key_cleared":...}.
Use Cases
Keep legacy deactivation scripts working through the rename window without edits.
Notes
Despite the name, this is not platform-only; it clears offline licenses too, exactly like Inlay_DEACTIVATE.
Migrate to Inlay_DEACTIVATE now; this alias is removed in 0.2.7.