Skip to content

Commit 2aca230

Browse files
committed
Add comments about functions not being public API
1 parent 10b3d5a commit 2aca230

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

libs/common/src/key-management/pin/pin-state.service.abstraction.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import { PinLockType } from "./pin-lock-type";
1313
export abstract class PinStateServiceAbstraction {
1414
/**
1515
* Gets the user's UserKey encrypted PIN
16+
* @deprecated - This is not a public API. DO NOT USE IT
1617
* @param userId The user's id
1718
* @throws If the user id is not provided
1819
*/
@@ -33,6 +34,7 @@ export abstract class PinStateServiceAbstraction {
3334

3435
/**
3536
* Gets the user's PIN-protected UserKey envelope, either persistent or ephemeral based on the provided PinLockType
37+
* @deprecated - This is not a public API. DO NOT USE IT
3638
* @param userId The user's id
3739
* @param pinLockType User's {@link PinLockType}.
3840
* @throws if the user id is not provided
@@ -53,6 +55,7 @@ export abstract class PinStateServiceAbstraction {
5355

5456
/**
5557
* Sets the PIN state for the user
58+
* @deprecated - This is not a public API. DO NOT USE IT
5659
* @param userId The user's id
5760
* @param pinProtectedUserKeyEnvelope The user's PIN-protected UserKey envelope
5861
* @param userKeyEncryptedPin The user's UserKey-encrypted PIN

0 commit comments

Comments
 (0)