From 957be667349093bec07e8b6623e24404ac7e312e Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Fri, 26 May 2023 14:28:13 +0100 Subject: [PATCH] Mark old classes as deprecated --- src/crypto/verification/Base.ts | 1 + src/crypto/verification/QRCode.ts | 1 + src/crypto/verification/SAS.ts | 1 + 3 files changed, 3 insertions(+) diff --git a/src/crypto/verification/Base.ts b/src/crypto/verification/Base.ts index 1f372c89073..18818989ed5 100644 --- a/src/crypto/verification/Base.ts +++ b/src/crypto/verification/Base.ts @@ -57,6 +57,7 @@ export type VerificationEventHandlerMap = { [VerificationEvent.Cancel]: (e: Error | MatrixEvent) => void; }; +/** @deprecated Avoid referencing this class directly; instead use {@link Crypto.Verifier}. */ // The type parameters of VerificationBase are no longer used, but we need some placeholders to maintain // backwards compatibility with applications that reference the class. export class VerificationBase< diff --git a/src/crypto/verification/QRCode.ts b/src/crypto/verification/QRCode.ts index a51db2e34e6..1a7538583f7 100644 --- a/src/crypto/verification/QRCode.ts +++ b/src/crypto/verification/QRCode.ts @@ -36,6 +36,7 @@ export type QrCodeEvent = VerifierEvent; /** @deprecated use VerifierEvent */ export const QrCodeEvent = VerifierEvent; +/** @deprecated Avoid referencing this class directly; instead use {@link Crypto.Verifier}. */ export class ReciprocateQRCode extends Base { public reciprocateQREvent?: ShowQrCodeCallbacks; diff --git a/src/crypto/verification/SAS.ts b/src/crypto/verification/SAS.ts index f15adf585f0..b5063c01d32 100644 --- a/src/crypto/verification/SAS.ts +++ b/src/crypto/verification/SAS.ts @@ -219,6 +219,7 @@ export type SasEvent = VerifierEvent; /** @deprecated use VerifierEvent */ export const SasEvent = VerifierEvent; +/** @deprecated Avoid referencing this class directly; instead use {@link Crypto.Verifier}. */ export class SAS extends Base { private waitingForAccept?: boolean; public ourSASPubKey?: string;