Skip to content

Commit a6199ee

Browse files
authored
Fix App Check documentation (#1064)
* Expand documentation for AppCheck * Update FirebaseAppCheck.cs
1 parent 159b2e8 commit a6199ee

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

app_check/src/FirebaseAppCheck.cs

+17-13
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@
2020
namespace Firebase.AppCheck {
2121

2222
/// @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
2331
public sealed class FirebaseAppCheck {
2432
// The C++ object that this wraps.
2533
private AppCheckInternal appCheckInternal;
@@ -53,15 +61,15 @@ private void ThrowIfNull() {
5361
}
5462

5563
/// Gets the instance of FirebaseAppCheck associated with the default
56-
/// {@link FirebaseApp} instance.
64+
/// FirebaseApp instance.
5765
public static FirebaseAppCheck DefaultInstance {
5866
get {
5967
return GetInstance(FirebaseApp.DefaultInstance);
6068
}
6169
}
6270

6371
/// Gets the instance of FirebaseAppCheck associated with the given
64-
/// {@link FirebaseApp} instance.
72+
/// FirebaseApp instance.
6573
public static FirebaseAppCheck GetInstance(FirebaseApp app) {
6674
FirebaseAppCheck result;
6775
if (!appCheckMap.TryGetValue(app.Name, out result)) {
@@ -72,18 +80,14 @@ public static FirebaseAppCheck GetInstance(FirebaseApp app) {
7280
return result;
7381
}
7482

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.
8085
///
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.
8791
///
8892
/// This method should be called before initializing the Firebase App.
8993
public static void SetAppCheckProviderFactory(IAppCheckProviderFactory factory) {

0 commit comments

Comments
 (0)