Skip to content

Commit 320a3ed

Browse files
authored
Adjust Functions Kotlin docs for release (#6449)
Adjusted Functions docs as well as vestigial visibility issues.
1 parent c7eb32a commit 320a3ed

File tree

11 files changed

+29
-326
lines changed

11 files changed

+29
-326
lines changed

firebase-functions/api.txt

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,10 @@ package com.google.firebase.functions {
2323
}
2424

2525
public final class FirebaseFunctionsException extends com.google.firebase.FirebaseException {
26-
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);
2726
method @NonNull public com.google.firebase.functions.FirebaseFunctionsException.Code getCode();
2827
method @Nullable public Object getDetails();
2928
property @NonNull public final com.google.firebase.functions.FirebaseFunctionsException.Code code;
3029
property @Nullable public final Object details;
31-
field @NonNull public static final com.google.firebase.functions.FirebaseFunctionsException.Companion Companion;
3230
}
3331

3432
public enum FirebaseFunctionsException.Code {
@@ -61,10 +59,6 @@ package com.google.firebase.functions {
6159
method @NonNull public com.google.firebase.functions.FirebaseFunctionsException.Code fromValue(int value);
6260
}
6361

64-
public static final class FirebaseFunctionsException.Companion {
65-
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);
66-
}
67-
6862
public final class FunctionsKt {
6963
method @NonNull public static com.google.firebase.functions.FirebaseFunctions functions(@NonNull com.google.firebase.Firebase, @NonNull String regionOrCustomDomain);
7064
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 {
7468
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);
7569
}
7670

77-
public final class HttpsCallOptions {
78-
ctor public HttpsCallOptions(@NonNull com.google.firebase.functions.HttpsCallableOptions publicCallableOptions);
79-
ctor public HttpsCallOptions();
80-
method @NonNull public okhttp3.OkHttpClient apply(@NonNull okhttp3.OkHttpClient client);
81-
method public boolean getLimitedUseAppCheckTokens();
82-
method public long getTimeout();
83-
method public void setTimeout(long timeout, @NonNull java.util.concurrent.TimeUnit units);
84-
field public final boolean limitedUseAppCheckTokens;
85-
}
86-
8771
public final class HttpsCallableOptions {
8872
method public boolean getLimitedUseAppCheckTokens();
8973
field public final boolean limitedUseAppCheckTokens;
@@ -100,11 +84,9 @@ package com.google.firebase.functions {
10084
public final class HttpsCallableReference {
10185
method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.functions.HttpsCallableResult> call(@Nullable Object data);
10286
method @NonNull public com.google.android.gms.tasks.Task<com.google.firebase.functions.HttpsCallableResult> call();
103-
method @NonNull public com.google.firebase.functions.HttpsCallOptions getOptions();
10487
method public long getTimeout();
10588
method public void setTimeout(long timeout, @NonNull java.util.concurrent.TimeUnit units);
10689
method @NonNull public com.google.firebase.functions.HttpsCallableReference withTimeout(long timeout, @NonNull java.util.concurrent.TimeUnit units);
107-
property @NonNull public final com.google.firebase.functions.HttpsCallOptions options;
10890
property public final long timeout;
10991
}
11092

@@ -113,18 +95,6 @@ package com.google.firebase.functions {
11395
field @Nullable public final Object data;
11496
}
11597

116-
public final class Serializer {
117-
ctor public Serializer();
118-
method @Nullable public Object decode(@NonNull Object obj);
119-
method @NonNull public Object encode(@Nullable Object obj);
120-
field @NonNull public static final com.google.firebase.functions.Serializer.Companion Companion;
121-
field @NonNull @VisibleForTesting public static final String LONG_TYPE = "type.googleapis.com/google.protobuf.Int64Value";
122-
field @NonNull @VisibleForTesting public static final String UNSIGNED_LONG_TYPE = "type.googleapis.com/google.protobuf.UInt64Value";
123-
}
124-
125-
public static final class Serializer.Companion {
126-
}
127-
12898
}
12999

130100
package com.google.firebase.functions.ktx {

firebase-functions/ktx/src/androidTest/kotlin/com/google/firebase/functions/ktx/CallTests.kt

Lines changed: 0 additions & 93 deletions
This file was deleted.

firebase-functions/ktx/src/test/kotlin/com/google/firebase/functions/TestVisibilityUtil.kt

Lines changed: 0 additions & 22 deletions
This file was deleted.

firebase-functions/ktx/src/test/kotlin/com/google/firebase/functions/ktx/FunctionsTests.kt

Lines changed: 0 additions & 153 deletions
This file was deleted.

firebase-functions/src/main/java/com/google/firebase/functions/FirebaseFunctions.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ internal constructor(
146146
}
147147
}
148148

149-
@Deprecated("Use {@link #useEmulator(String, int)} to connect to the emulator. ")
149+
@Deprecated("Use useEmulator to connect to the emulator.")
150150
public fun useFunctionsEmulator(origin: String) {
151151
Preconditions.checkNotNull(origin, "origin cannot be null")
152152
urlFormat = "$origin/%2\$s/%1\$s/%3\$s"

0 commit comments

Comments
 (0)