saveTempOnlineUnlimited

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

Method signature
saveTempOnlineUnlimited(params: )

Description

Save an online unlimited-use password

Parameters

ParameterTypeRequiredDescription
YesInput parameters

Return Value

Type: Promise<SaveTempOnlineUnlimitedResult>
None (resolve after successful save)
SaveTempOnlineUnlimitedResult
PropertyTypeDescription
type"custom"Password type; fixed as `custom` (custom, unlimited uses) for this API
namestringPassword name
pwdIdstringCloud password ID; used to locate the record for subsequent deletion/modification
Validity settings (effective/expiry time and weekly recurrence)

Error Code

Error CodeError Message
1030Invalid password format
1031Password name too long (over 20 characters)
1032Missing validity time settings
1033Missing start date
1034Missing end date
1010Start time is later than expiry time
1035weeks not provided in weekly repeat mode
1037Cloud: Password already exists (USER_PWD_ALREADY_EXIST)
1038Cloud: Duplicate password name (LOCK_PWD_NAME_REPEAT)
1039Cloud: Invalid time parameters (START_END_DATE_NOT_RIGHT)

Referenced Types

interfaceEffectiveConfig
PropertyTypeRequiredDescription
effectiveDatenumberYesEffective date (seconds-level timestamp)
expiredDatenumberYesExpiration date (seconds-level timestamp)
repeat"none" | "week"NoRepeat policy: none or weekly
weeksWeekNoWeekly repeat bitmap
effectiveTimenumberNoDaily start time (minutes)
expiredTimenumberNoDaily end time (minutes)
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 { saveTempOnlineUnlimited } from '@ray-js/lock-sdk';
saveTempOnlineUnlimited({ password: '654321', name: 'Unlimited-use password' });