Adjust Functions Kotlin docs for release (#6449)

Adjusted Functions docs as well as vestigial visibility issues.
firebase · Dec 27, 2024 · 320a3ed · 320a3ed
1 parent c7eb32a
commit 320a3ed
Show file tree

Hide file tree

Showing 11 changed files with 29 additions and 326 deletions.
diff --git a/firebase-functions/api.txt b/firebase-functions/api.txt
@@ -23,12 +23,10 @@ package com.google.firebase.functions {
   }
 
   public final class FirebaseFunctionsException extends com.google.firebase.FirebaseException {
-    method @Nullable public static com.google.firebase.functions.FirebaseFunctionsException fromResponse(@NonNull com.google.firebase.functions.FirebaseFunctionsException.Code code, @Nullable String body, @NonNull com.google.firebase.functions.Serializer serializer);
     method @NonNull public com.google.firebase.functions.FirebaseFunctionsException.Code getCode();
     method @Nullable public Object getDetails();
     property @NonNull public final com.google.firebase.functions.FirebaseFunctionsException.Code code;
     property @Nullable public final Object details;
-    field @NonNull public static final com.google.firebase.functions.FirebaseFunctionsException.Companion Companion;
   }
 
   public enum FirebaseFunctionsException.Code {
@@ -61,10 +59,6 @@ package com.google.firebase.functions {
     method @NonNull public com.google.firebase.functions.FirebaseFunctionsException.Code fromValue(int value);
   }
 
-  public static final class FirebaseFunctionsException.Companion {
-    method @Nullable public com.google.firebase.functions.FirebaseFunctionsException fromResponse(@NonNull com.google.firebase.functions.FirebaseFunctionsException.Code code, @Nullable String body, @NonNull com.google.firebase.functions.Serializer serializer);
-  }
-
   public final class FunctionsKt {
     method @NonNull public static com.google.firebase.functions.FirebaseFunctions functions(@NonNull com.google.firebase.Firebase, @NonNull String regionOrCustomDomain);
     method @NonNull public static com.google.firebase.functions.FirebaseFunctions functions(@NonNull com.google.firebase.Firebase, @NonNull com.google.firebase.FirebaseApp app);
@@ -74,16 +68,6 @@ package com.google.firebase.functions {
     method @NonNull public static com.google.firebase.functions.HttpsCallableReference getHttpsCallableFromUrl(@NonNull com.google.firebase.functions.FirebaseFunctions, @NonNull java.net.URL url, @NonNull kotlin.jvm.functions.Function1<? super com.google.firebase.functions.HttpsCallableOptions.Builder,kotlin.Unit> init);
   }
 
-  public final class HttpsCallOptions {
-    ctor public HttpsCallOptions(@NonNull com.google.firebase.functions.HttpsCallableOptions publicCallableOptions);
-    ctor public HttpsCallOptions();
-    method @NonNull public okhttp3.OkHttpClient apply(@NonNull okhttp3.OkHttpClient client);
-    method public boolean getLimitedUseAppCheckTokens();
-    method public long getTimeout();
-    method public void setTimeout(long timeout, @NonNull java.util.concurrent.TimeUnit units);
-    field public final boolean limitedUseAppCheckTokens;
-  }
-
   public final class HttpsCallableOptions {
     method public boolean getLimitedUseAppCheckTokens();
     field public final boolean limitedUseAppCheckTokens;
@@ -100,11 +84,9 @@ package com.google.firebase.functions {
   public final class HttpsCallableReference {
     method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.functions.HttpsCallableResult> call(@Nullable Object data);
     method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.functions.HttpsCallableResult> call();
-    method @NonNull public com.google.firebase.functions.HttpsCallOptions getOptions();
     method public long getTimeout();
     method public void setTimeout(long timeout, @NonNull java.util.concurrent.TimeUnit units);
     method @NonNull public com.google.firebase.functions.HttpsCallableReference withTimeout(long timeout, @NonNull java.util.concurrent.TimeUnit units);
-    property @NonNull public final com.google.firebase.functions.HttpsCallOptions options;
     property public final long timeout;
   }
 
@@ -113,18 +95,6 @@ package com.google.firebase.functions {
     field @Nullable public final Object data;
   }
 
-  public final class Serializer {
-    ctor public Serializer();
-    method @Nullable public Object decode(@NonNull Object obj);
-    method @NonNull public Object encode(@Nullable Object obj);
-    field @NonNull public static final com.google.firebase.functions.Serializer.Companion Companion;
-    field @NonNull @VisibleForTesting public static final String LONG_TYPE = "type.googleapis.com/google.protobuf.Int64Value";
-    field @NonNull @VisibleForTesting public static final String UNSIGNED_LONG_TYPE = "type.googleapis.com/google.protobuf.UInt64Value";
-  }
-
-  public static final class Serializer.Companion {
-  }
-
 }
 
 package com.google.firebase.functions.ktx {

diff --git a/firebase-functions/ktx/src/androidTest/kotlin/com/google/firebase/functions/ktx/CallTests.kt b/firebase-functions/ktx/src/androidTest/kotlin/com/google/firebase/functions/ktx/CallTests.kt
diff --git a/firebase-functions/ktx/src/test/kotlin/com/google/firebase/functions/TestVisibilityUtil.kt b/firebase-functions/ktx/src/test/kotlin/com/google/firebase/functions/TestVisibilityUtil.kt
diff --git a/firebase-functions/ktx/src/test/kotlin/com/google/firebase/functions/ktx/FunctionsTests.kt b/firebase-functions/ktx/src/test/kotlin/com/google/firebase/functions/ktx/FunctionsTests.kt
diff --git a/firebase-functions/src/main/java/com/google/firebase/functions/FirebaseFunctions.kt b/firebase-functions/src/main/java/com/google/firebase/functions/FirebaseFunctions.kt
@@ -146,7 +146,7 @@ internal constructor(
     }
   }
 
-  @Deprecated("Use {@link #useEmulator(String, int)} to connect to the emulator. ")
+  @Deprecated("Use useEmulator to connect to the emulator.")
   public fun useFunctionsEmulator(origin: String) {
     Preconditions.checkNotNull(origin, "origin cannot be null")
     urlFormat = "$origin/%2\$s/%1\$s/%3\$s"