updateTempCustom(params: UpdateTempPasswordParams)

Requires:
@ray-js/lock-sdk≥1.0.0

Description

Update a custom temporary password.

Parameters

ParameterTypeRequiredDescription
YesUpdate parameters

Return Value

Type: Promise<boolean>
None (resolve after successful update)

Error Code

Error CodeError Message
1031Password name too long (over 20 characters)
1032Missing validity time settings
1033Missing start date
1034Missing end date
1010Start time is later than end time
1035weeks not provided in weekly repeat mode
1039Cloud: Invalid time parameters (START_END_DATE_NOT_RIGHT)

Referenced Types

typeWeekWeekly repeat bitmap: indices 0–6 correspond to Sun–Sat; 0 inactive, 1 active
export type Week = [
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
];

Valid Values

EffectiveConfig.repeat
ValueDescriptionSince
none--
week--
Week
ValueDescriptionSince
0--
1--

Examples

import { updateTempCustom } from '@ray-js/lock-sdk';
await updateTempCustom({ id: 'pwd_001', name: 'New password name' });