Skip to main content

Device Config

Config Edit

deviceSettings Used to modify device-level configuration, such as device name, language, Passphrase switch, automatic lock time, etc. Since these operations usually require confirmation on the device, modify only one attribute at a time to facilitate users to understand this change.

const callResult = await ukeySdk.deviceSettings(connectId, requestParams);

Input Fields

Reusable request options

  • language - string; device language, using an ISO 639-1 code.
  • label - string; name shown for the device.
  • usePassphrase - boolean; enable the Passphrase feature.
  • homescreen - string; hex payload for replacing the home screen image.
  • autoLockDelayMs - number; auto-lock delay in milliseconds.
  • displayRotation - number; screen rotation setting.
  • passphraseAlwaysOnDevice - boolean; require Passphrase entry on the device instead of software input.
  • safetyChecks - string; safety-check level. Prompt limits path namespace checks.

0: Strict 1: PromptAlways 2: PromptTemporarily

  • experimentalFeatures - boolean; enable experimental message types.

Reference Snippet

ukeySdk.deviceSettings(connectId, {
slot: 'My UKey Wallet'
});

Result

{
success: true,
payload: {
message: string
}
}

Errors

{
success: false,
payload: {
error: string, // Error message text
code: number // Error code value
}
}