Firebase. Functions. FirebaseFunctions
FirebaseFunctions is a service that supports calling Google CloudFunctions.
Summary
FirebaseFunctions is a service that supports calling Google CloudFunctions. Pass a custom instance ofFirebase.FirebaseApp toGetInstance which will useAuth and InstanceID from the app.
Otherwise, if you callDefaultInstance without aFirebaseApp, theFirebaseFunctions instance will initialize with the defaultFirebase.FirebaseApp obtainable fromFirebaseApp.DefaultInstance.
Properties | |
|---|---|
App | TheFirebase.FirebaseApp associated with thisFirebaseFunctions instance. |
DefaultInstance | staticFirebaseFunctionsReturns theFirebaseFunctions , initialized with the defaultFirebase.FirebaseApp |
Public static functions | |
|---|---|
GetInstance(FirebaseApp app) | Returns theFirebaseFunctions , initialized with a customFirebase.FirebaseApp |
GetInstance(string region) | Returns theFirebaseFunctions , initialized with the defaultFirebase.FirebaseApp. |
GetInstance(FirebaseApp app, string region) | Returns theFirebaseFunctions , initialized with a customFirebase.FirebaseApp and region. |
Public functions | |
|---|---|
GetHttpsCallable(string name) | Creates aHttpsCallableReference given a name. |
GetHttpsCallableFromURL(string url) | Creates aHttpsCallableReference given a URL. |
GetHttpsCallableFromURL(Uri url) | Creates aHttpsCallableReference given a URL. |
UseFunctionsEmulator(string origin) | voidSets an origin of a CloudFunctions Emulator instance to use. |
Properties
DefaultInstance
staticFirebaseFunctionsDefaultInstance
Returns theFirebaseFunctions , initialized with the defaultFirebase.FirebaseApp
aFirebaseFunctions instance.
Public static functions
GetInstance
FirebaseFunctionsGetInstance(FirebaseAppapp)
Returns theFirebaseFunctions , initialized with a customFirebase.FirebaseApp
| Details | |||
|---|---|---|---|
| Parameters |
| ||
| Returns | aFirebaseFunctions instance. |
GetInstance
FirebaseFunctionsGetInstance(stringregion)
Returns theFirebaseFunctions , initialized with the defaultFirebase.FirebaseApp.
| Details | |||
|---|---|---|---|
| Parameters |
| ||
| Returns | aFirebaseFunctions instance. |
GetInstance
FirebaseFunctionsGetInstance(FirebaseAppapp,stringregion)
Returns theFirebaseFunctions , initialized with a customFirebase.FirebaseApp and region.
| Details | |||
|---|---|---|---|
| Parameters |
| ||
| Returns | aFirebaseFunctions instance. |
Public functions
GetHttpsCallable
HttpsCallableReferenceGetHttpsCallable(stringname)
Creates aHttpsCallableReference given a name.
GetHttpsCallableFromURL
HttpsCallableReferenceGetHttpsCallableFromURL(stringurl)
Creates aHttpsCallableReference given a URL.
GetHttpsCallableFromURL
HttpsCallableReferenceGetHttpsCallableFromURL(Uriurl)
Creates aHttpsCallableReference given a URL.
UseFunctionsEmulator
voidUseFunctionsEmulator(stringorigin)
Sets an origin of a CloudFunctions Emulator instance to use.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-06-11 UTC.