Skip to content

Commit fc42195

Browse files
authored
redeclare protocol method so it can be added to docs (#12142)
1 parent a669d64 commit fc42195

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppAttestProvider.h

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,26 @@ NS_SWIFT_NAME(AppAttestProvider)
4040
/// required parameters.
4141
- (nullable instancetype)initWithApp:(FIRApp *)app;
4242

43+
/* Jazzy doesn't generate documentation for protocol-inherited
44+
* methods, so this is copied over from the protocol declaration.
45+
*/
46+
/// Returns a new Firebase App Check token.
47+
/// @param handler The completion handler. Make sure to call the handler with either a token
48+
/// or an error.
49+
- (void)getTokenWithCompletion:
50+
(void (^)(FIRAppCheckToken *_Nullable token, NSError *_Nullable error))handler
51+
NS_SWIFT_NAME(getToken(completion:));
52+
53+
/// Returns a new Firebase App Check token.
54+
/// When implementing this method for your custom provider, the token returned should be suitable
55+
/// for consumption in a limited-use scenario. If you do not implement this method, the
56+
/// getTokenWithCompletion will be invoked instead whenever a limited-use token is requested.
57+
/// @param handler The completion handler. Make sure to call the handler with either a token
58+
/// or an error.
59+
- (void)getLimitedUseTokenWithCompletion:
60+
(void (^)(FIRAppCheckToken *_Nullable token, NSError *_Nullable error))handler
61+
NS_SWIFT_NAME(getLimitedUseToken(completion:));
62+
4363
@end
4464

4565
NS_ASSUME_NONNULL_END

FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRAppCheckDebugProvider.h

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,26 @@ NS_SWIFT_NAME(AppCheckDebugProvider)
7979
*/
8080
- (NSString *)currentDebugToken;
8181

82+
/* Jazzy doesn't generate documentation for protocol-inherited
83+
* methods, so this is copied over from the protocol declaration.
84+
*/
85+
/// Returns a new Firebase App Check token.
86+
/// @param handler The completion handler. Make sure to call the handler with either a token
87+
/// or an error.
88+
- (void)getTokenWithCompletion:
89+
(void (^)(FIRAppCheckToken *_Nullable token, NSError *_Nullable error))handler
90+
NS_SWIFT_NAME(getToken(completion:));
91+
92+
/// Returns a new Firebase App Check token.
93+
/// When implementing this method for your custom provider, the token returned should be suitable
94+
/// for consumption in a limited-use scenario. If you do not implement this method, the
95+
/// getTokenWithCompletion will be invoked instead whenever a limited-use token is requested.
96+
/// @param handler The completion handler. Make sure to call the handler with either a token
97+
/// or an error.
98+
- (void)getLimitedUseTokenWithCompletion:
99+
(void (^)(FIRAppCheckToken *_Nullable token, NSError *_Nullable error))handler
100+
NS_SWIFT_NAME(getLimitedUseToken(completion:));
101+
82102
@end
83103

84104
NS_ASSUME_NONNULL_END

FirebaseAppCheck/Sources/Public/FirebaseAppCheck/FIRDeviceCheckProvider.h

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,26 @@ NS_SWIFT_NAME(DeviceCheckProvider)
4141
/// required parameters.
4242
- (nullable instancetype)initWithApp:(FIRApp *)app;
4343

44+
/* Jazzy doesn't generate documentation for protocol-inherited
45+
* methods, so this is copied over from the protocol declaration.
46+
*/
47+
/// Returns a new Firebase App Check token.
48+
/// @param handler The completion handler. Make sure to call the handler with either a token
49+
/// or an error.
50+
- (void)getTokenWithCompletion:
51+
(void (^)(FIRAppCheckToken *_Nullable token, NSError *_Nullable error))handler
52+
NS_SWIFT_NAME(getToken(completion:));
53+
54+
/// Returns a new Firebase App Check token.
55+
/// When implementing this method for your custom provider, the token returned should be suitable
56+
/// for consumption in a limited-use scenario. If you do not implement this method, the
57+
/// getTokenWithCompletion will be invoked instead whenever a limited-use token is requested.
58+
/// @param handler The completion handler. Make sure to call the handler with either a token
59+
/// or an error.
60+
- (void)getLimitedUseTokenWithCompletion:
61+
(void (^)(FIRAppCheckToken *_Nullable token, NSError *_Nullable error))handler
62+
NS_SWIFT_NAME(getLimitedUseToken(completion:));
63+
4464
@end
4565

4666
NS_ASSUME_NONNULL_END

0 commit comments

Comments
 (0)