Skip to content

Commit a6164a8

Browse files
authored
[AppCheck] Refine public docs (#10265)
skip ci
1 parent f233d5b commit a6164a8

File tree

3 files changed

+12
-2
lines changed

3 files changed

+12
-2
lines changed

FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppAttestProvider.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,20 @@
2424

2525
NS_ASSUME_NONNULL_BEGIN
2626

27+
/// Firebase App Check provider that verifies app integrity using the
28+
/// [DeviceCheck](https://developer.apple.com/documentation/devicecheck/dcappattestservice) API.
29+
/// This class is available on all platforms for select OS versions. See
30+
/// https://firebase.google.com/docs/ios/learn-more for more details.
2731
FIR_APP_ATTEST_PROVIDER_AVAILABILITY
2832
NS_SWIFT_NAME(AppAttestProvider)
2933
@interface FIRAppAttestProvider : NSObject <FIRAppCheckProvider>
3034

3135
- (instancetype)init NS_UNAVAILABLE;
3236

37+
/// The default initializer.
38+
/// @param app A `FirebaseApp` instance.
39+
/// @return An instance of `AppAttestProvider` if the provided `FirebaseApp` instance contains all
40+
/// required parameters.
3341
- (nullable instancetype)initWithApp:(FIRApp *)app;
3442

3543
@end

FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRDeviceCheckProvider.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ NS_ASSUME_NONNULL_BEGIN
2929

3030
/// Firebase App Check provider that verifies app integrity using the
3131
/// [DeviceCheck](https://developer.apple.com/documentation/devicecheck) API.
32-
/// This class is available on iOS, macOS Catalyst, macOS, and tvOS only.
32+
/// This class is available on all platforms for select OS versions. See
33+
/// https://firebase.google.com/docs/ios/learn-more for more details.
3334
FIR_DEVICE_CHECK_PROVIDER_AVAILABILITY
3435
NS_SWIFT_NAME(DeviceCheckProvider)
3536
@interface FIRDeviceCheckProvider : NSObject <FIRAppCheckProvider>

FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRDeviceCheckProviderFactory.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ NS_ASSUME_NONNULL_BEGIN
2828
/// `DeviceCheckProvider` for the specified `FirebaseApp` on request. Currently
2929
/// `DeviceCheckProviderFactory` is the default that will be used by Firebase App Check if no other
3030
/// provider is specified. See `AppCheck` class for more details.
31-
/// This class is available on iOS, macOS Catalyst, macOS, and tvOS only.
31+
/// This class is available on all platforms for select OS versions. See
32+
/// https://firebase.google.com/docs/ios/learn-more for more details.
3233
FIR_DEVICE_CHECK_PROVIDER_AVAILABILITY
3334
NS_SWIFT_NAME(DeviceCheckProviderFactory)
3435
@interface FIRDeviceCheckProviderFactory : NSObject <FIRAppCheckProviderFactory>

0 commit comments

Comments
 (0)