mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-09 22:36:01 +05:45
Bryan Klimt
f08edbb85c
* Add a Functions constructor that allows setting a region. * Add a method to set an emulator origin to use. * Update the changelog
74 lines
2.4 KiB
Objective-C
74 lines
2.4 KiB
Objective-C
// Copyright 2017 Google
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
@class FIRApp;
|
|
@class FIRHTTPSCallable;
|
|
|
|
/**
|
|
* `FIRFunctions` is the client for Cloud Functions for a Firebase project.
|
|
*/
|
|
NS_SWIFT_NAME(Functions)
|
|
@interface FIRFunctions : NSObject
|
|
|
|
- (id)init NS_UNAVAILABLE;
|
|
|
|
/**
|
|
* Creates a Cloud Functions client with the default app.
|
|
*/
|
|
+ (instancetype)functions NS_SWIFT_NAME(functions());
|
|
|
|
/**
|
|
* Creates a Cloud Functions client with the given app.
|
|
* @param app The app for the Firebase project.
|
|
*/
|
|
+ (instancetype)functionsForApp:(FIRApp *)app NS_SWIFT_NAME(functions(app:));
|
|
|
|
/**
|
|
* Creates a Cloud Functions client with the default app and given region.
|
|
* @param region The region for the http trigger, such as "us-central1".
|
|
*/
|
|
+ (instancetype)functionsForRegion:(NSString *)region NS_SWIFT_NAME(functions(region:));
|
|
|
|
/**
|
|
* Creates a Cloud Functions client with the given app and region.
|
|
* @param app The app for the Firebase project.
|
|
* @param region The region for the http trigger, such as "us-central1".
|
|
*/
|
|
// clang-format off
|
|
// because it incorrectly breaks this NS_SWIFT_NAME.
|
|
+ (instancetype)functionsForApp:(FIRApp *)app
|
|
region:(NSString *)region NS_SWIFT_NAME(functions(app:region:));
|
|
// clang-format on
|
|
|
|
/**
|
|
* Creates a reference to the Callable HTTPS trigger with the given name.
|
|
* @param name The name of the Callable HTTPS trigger.
|
|
*/
|
|
- (FIRHTTPSCallable *)HTTPSCallableWithName:(NSString *)name NS_SWIFT_NAME(httpsCallable(_:));
|
|
|
|
/**
|
|
* Changes this instance to point to a Cloud Functions emulator running locally.
|
|
* See https://firebase.google.com/docs/functions/local-emulator
|
|
* @param origin The origin of the local emulator, such as "http://localhost:5005".
|
|
*/
|
|
- (void)useFunctionsEmulatorOrigin:(NSString *)origin NS_SWIFT_NAME(useFunctionsEmulator(origin:));
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|