20
20
namespace Firebase . AppCheck {
21
21
22
22
/// @brief Firebase App Check object.
23
+ ///
24
+ /// App Check helps protect your API resources from abuse by preventing
25
+ /// unauthorized clients from accessing your backend resources.
26
+ ///
27
+ /// With App Check, devices running your app will use an AppCheckProvider that
28
+ /// attests to one or both of the following:
29
+ /// * Requests originate from your authentic app
30
+ /// * Requests originate from an authentic, untampered device
23
31
public sealed class FirebaseAppCheck {
24
32
// The C++ object that this wraps.
25
33
private AppCheckInternal appCheckInternal ;
@@ -53,15 +61,15 @@ private void ThrowIfNull() {
53
61
}
54
62
55
63
/// Gets the instance of FirebaseAppCheck associated with the default
56
- /// {@link FirebaseApp} instance.
64
+ /// FirebaseApp instance.
57
65
public static FirebaseAppCheck DefaultInstance {
58
66
get {
59
67
return GetInstance ( FirebaseApp . DefaultInstance ) ;
60
68
}
61
69
}
62
70
63
71
/// Gets the instance of FirebaseAppCheck associated with the given
64
- /// {@link FirebaseApp} instance.
72
+ /// FirebaseApp instance.
65
73
public static FirebaseAppCheck GetInstance ( FirebaseApp app ) {
66
74
FirebaseAppCheck result ;
67
75
if ( ! appCheckMap . TryGetValue ( app . Name , out result ) ) {
@@ -72,18 +80,14 @@ public static FirebaseAppCheck GetInstance(FirebaseApp app) {
72
80
return result ;
73
81
}
74
82
75
- /// Installs the given {@link AppCheckProviderFactory}, overwriting any that
76
- /// were previously associated with this {@code FirebaseAppCheck} instance.
77
- /// Any {@link AppCheckTokenListener}s attached to this
78
- /// {@code FirebaseAppCheck} instance will be transferred from existing
79
- /// factories to the newly installed one.
83
+ /// Installs the given IAppCheckProviderFactory, overwriting any that
84
+ /// were previously associated with this FirebaseAppCheck instance.
80
85
///
81
- /// <p>Automatic token refreshing will only occur if the global {@code
82
- /// isDataCollectionDefaultEnabled} flag is set to true. To allow automatic
83
- /// token refreshing for Firebase App Check without changing the {@code
84
- /// isDataCollectionDefaultEnabled} flag for other Firebase SDKs, call
85
- /// {@link #setTokenAutoRefreshEnabled(bool)} after installing the {@code
86
- /// factory}.
86
+ /// Automatic token refreshing will only occur if the global
87
+ /// isDataCollectionDefaultEnabled flag is set to true. To allow automatic
88
+ /// token refreshing for Firebase App Check without changing the
89
+ /// isDataCollectionDefaultEnabled flag for other Firebase SDKs, call
90
+ /// SetTokenAutoRefreshEnabled(bool) after installing the factory.
87
91
///
88
92
/// This method should be called before initializing the Firebase App.
89
93
public static void SetAppCheckProviderFactory ( IAppCheckProviderFactory factory ) {
0 commit comments