अपने ऐप्लिकेशन से फ़ंक्शन कॉल करें

2nd gen 1st gen

Cloud Functions for Firebase क्लाइंट SDK टूल की मदद से, सीधे Firebase ऐप्लिकेशन से फ़ंक्शन को कॉल किया जा सकता है. इस तरह से अपने ऐप्लिकेशन से किसी फ़ंक्शन को कॉल करने के लिए, Cloud Functions में HTTP कॉल किया जा सकने वाला फ़ंक्शन लिखें और उसे डिप्लॉय करें. इसके बाद, अपने ऐप्लिकेशन से फ़ंक्शन को कॉल करने के लिए क्लाइंट लॉजिक जोड़ें.

यह ध्यान रखना ज़रूरी है कि एचटीटीपी कॉल किए जा सकने वाले फ़ंक्शन, एचटीटीपी फ़ंक्शन से मिलते-जुलते होते हैं, लेकिन एक जैसे नहीं होते. एचटीटीपी कॉल किए जा सकने वाले फ़ंक्शन का इस्तेमाल करने के लिए, आपको अपने प्लैटफ़ॉर्म के लिए क्लाइंट एसडीके टूल का इस्तेमाल करना होगा. साथ ही, आपको बैकएंड एपीआई का इस्तेमाल करना होगा या प्रोटोकॉल लागू करना होगा. कॉल करने की सुविधाओं में, एचटीटीपी फ़ंक्शन से ये मुख्य अंतर होते हैं:

• कॉल करने की सुविधा वाले एलिमेंट के साथ, Firebase Authentication टोकन, FCM टोकन, और App Check टोकन, उपलब्ध होने पर अनुरोधों में अपने-आप शामिल हो जाते हैं.
• ट्रिगर, अनुरोध बॉडी को अपने-आप डिसीरियलाइज़ करता है और पुष्टि करने वाले टोकन की पुष्टि करता है.

Cloud Functions के दूसरे जनरेशन और उसके बाद के वर्शन के लिए Firebase SDK टूल, एचटीटीपीएस कॉल करने की सुविधा के साथ काम करने के लिए, Firebase क्लाइंट SDK टूल के इन वर्शन के साथ काम करता है:

• Firebase Apple प्लैटफ़ॉर्म के लिए SDK टूल 11.12.0
• Android 21.2.1 के लिए Firebase SDK टूल
• Firebase मॉड्यूलर वेब SDK टूल का वर्शन 9.7.0

अगर आपको किसी ऐसे प्लैटफ़ॉर्म पर बने ऐप्लिकेशन में मिलती-जुलती सुविधा जोड़नी है जिस पर यह सुविधा काम नहीं करती, तो https.onCall के लिए प्रोटोकॉल स्पेसिफ़िकेशन देखें. इस गाइड के बाकी हिस्से में, Apple प्लैटफ़ॉर्म, Android, वेब, C++, और Unity के लिए, एचटीटीपी कॉल किए जा सकने वाले फ़ंक्शन को लिखने, डिप्लॉय करने, और कॉल करने का तरीका बताया गया है.

कॉल किया जा सकने वाला फ़ंक्शन लिखना और डिप्लॉय करना

एचटीटीपीएस कॉल करने वाला फ़ंक्शन बनाने के लिए, functions.https.onCall का इस्तेमाल करें. इस तरीके में दो पैरामीटर इस्तेमाल किए जाते हैं: data और वैकल्पिक context:

  // Saves a message to the Firebase Realtime Database but sanitizes the
  // text by removing swearwords.
  exports.addMessage = functions.https.onCall((data, context) => {
    // ...
  });
  

उदाहरण के लिए, Realtime Database में टेक्स्ट मैसेज सेव करने वाले कॉल किए जा सकने वाले फ़ंक्शन के लिए, data में मैसेज का टेक्स्ट हो सकता है, जबकि context पैरामीटर में उपयोगकर्ता की पुष्टि करने की जानकारी हो सकती है:

// Message text passed from the client.
const text = request.data.text;
// Authentication / user information is automatically added to the request.
const uid = request.auth.uid;
const name = request.auth.token.name || null;
const picture = request.auth.token.picture || null;
const email = request.auth.token.email || null;
index.js

कॉल किए जा सकने वाले फ़ंक्शन की जगह और कॉल करने वाले क्लाइंट की जगह के बीच की दूरी की वजह से, नेटवर्क इंतज़ार का समय बढ़ सकता है. परफ़ॉर्मेंस को ऑप्टिमाइज़ करने के लिए, जहां भी लागू हो वहां फ़ंक्शन की जगह की जानकारी दें. साथ ही, क्लाइंट साइड पर एसडीके टूल को शुरू करने के दौरान, कॉल किए जा सकने वाले फ़ंक्शन की जगह को उस जगह से अलाइन करना न भूलें जिसे सेट किया गया है.

इसके अलावा, अपने बैकएंड संसाधनों को गलत इस्तेमाल से बचाने के लिए, App Check पुष्टि करने वाला दस्तावेज़ अटैच किया जा सकता है. जैसे, बिलिंग धोखाधड़ी या फ़िशिंग. Cloud Functions के लिए App Check एनफ़ोर्समेंट चालू करें देखें.

ध्यान दें: कॉल किए जा सकने वाले फ़ंक्शन लिखने के लिए, सिर्फ़ functions.https बैकएंड एपीआई का इस्तेमाल करें. एचटीटीपी ट्रिगर एपीआई, कॉल किए जा सकने वाले फ़ंक्शन से पूरी तरह से अलग है और साथ में काम नहीं करता.

चेतावनी: 7.7.0 से पहले के वर्शन वाले किसी भी Firebase सीएलआई के साथ डिप्लॉय किए गए नए एचटीटीपी और एचटीटीपी कॉल किए जा सकने वाले फ़ंक्शन, डिफ़ॉल्ट रूप से निजी होते हैं और उन्हें कॉल करने पर, एचटीटीपी 403 गड़बड़ियां दिखती हैं. किसी भी नए फ़ंक्शन को डिप्लॉय करने से पहले, इन फ़ंक्शन को सार्वजनिक तौर पर उपलब्ध कराएं या अपना Firebase सीएलआई अपडेट करें.

नतीजा भेजना

क्लाइंट को डेटा वापस भेजने के लिए, ऐसा डेटा दिखाएं जिसे JSON कोड में बदला जा सके. उदाहरण के लिए, जोड़ने की कार्रवाई का नतीजा दिखाने के लिए:

// returning result.
return {
  firstNumber: firstNumber,
  secondNumber: secondNumber,
  operator: "+",
  operationResult: firstNumber + secondNumber,
};
index.js

असाइनमेंट के पूरा होने के बाद डेटा दिखाने के लिए, कोई प्रॉमिस लौटाएं. Promise के ज़रिए मिलने वाला डेटा, क्लाइंट को वापस भेज दिया जाता है. उदाहरण के लिए, आपके पास Realtime Database में, कॉल किए जा सकने वाले फ़ंक्शन से मिला ऐसा टेक्स्ट दिखाने का विकल्प है जिसे साफ़ किया गया है:

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize message.

return getDatabase().ref("/messages").push({
  text: sanitizedMessage,
  author: {uid, name, picture, email},
}).then(() => {
  logger.info("New Message written");
  // Returning the sanitized message to the client.
  return {text: sanitizedMessage};
})
index.js

गड़बड़ियां ठीक करना

यह पक्का करने के लिए कि क्लाइंट को गड़बड़ी की काम की जानकारी मिल जाए, functions.https.HttpsError के किसी इंस्टेंस को फेंककर (या अस्वीकार किए गए प्रॉमिस को वापस करके) कॉल किए जा सकने वाले फ़ंक्शन से गड़बड़ियां दिखाएं. गड़बड़ी में code एट्रिब्यूट है, जो functions.https.HttpsError में दी गई वैल्यू में से एक हो सकता है. गड़बड़ियों में एक स्ट्रिंग message भी होती है, जो डिफ़ॉल्ट रूप से खाली स्ट्रिंग होती है. इनमें वैकल्पिक details फ़ील्ड भी हो सकता है, जिसमें अपनी पसंद के मुताबिक वैल्यू डाली जा सकती है. अगर आपके फ़ंक्शन से HttpsError के अलावा कोई दूसरी गड़बड़ी मिलती है, तो आपके क्लाइंट को गड़बड़ी का मैसेज INTERNAL और कोड internal मिलता है.

उदाहरण के लिए, कोई फ़ंक्शन, डेटा की पुष्टि करने और पुष्टि करने से जुड़ी गड़बड़ियां दिखा सकता है. साथ ही, कॉल करने वाले क्लाइंट को गड़बड़ी के मैसेज दिखा सकता है:

// Checking attribute.
if (!(typeof text === "string") || text.length === 0) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new HttpsError("invalid-argument", "The function must be called " +
          "with one arguments \"text\" containing the message text to add.");
}
// Checking that the user is authenticated.
if (!request.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new HttpsError("failed-precondition", "The function must be " +
          "called while authenticated.");
}
index.js

कॉल किए जा सकने वाले फ़ंक्शन को डिप्लॉय करना

index.js में, कॉल किए जा सकने वाले फ़ंक्शन को सेव करने के बाद, firebase deploy को चलाने पर, उसे अन्य सभी फ़ंक्शन के साथ डिप्लॉय किया जाता है. सिर्फ़ कॉल किए जा सकने वाले फ़ंक्शन को डिप्लॉय करने के लिए, --only आर्ग्युमेंट का इस्तेमाल करें, जैसा कि कुछ हिस्से को डिप्लॉय करने के लिए दिखाया गया है:

firebase deploy --only functions:addMessage

अगर फ़ंक्शन डिप्लॉय करते समय आपको अनुमतियों से जुड़ी गड़बड़ियां मिलती हैं, तो पक्का करें कि डिप्लॉयमेंट निर्देश चलाने वाले उपयोगकर्ता को सही IAM भूमिकाएं असाइन की गई हों.

क्लाइंट डेवलपमेंट एनवायरमेंट सेट अप करना

पक्का करें कि आपने सभी ज़रूरी शर्तें पूरी कर ली हों. इसके बाद, अपने ऐप्लिकेशन में ज़रूरी डिपेंडेंसी और क्लाइंट लाइब्रेरी जोड़ें.

iOS+

अपने Apple ऐप्लिकेशन में Firebase जोड़ने के लिए, निर्देशों का पालन करें.

Firebase डिपेंडेंसी इंस्टॉल और मैनेज करने के लिए, Swift Package Manager का इस्तेमाल करें.

अपने Apple प्रोजेक्ट में Firebase SDK टूल जोड़ने के अलग-अलग तरीकों के बारे में जानने के लिए,

SDK टूल इंस्टॉल करने के लिए बनी हमारी गाइड पर जाएं. इसमें, फ़्रेमवर्क को सीधे इंपोर्ट करने और CocoaPods का इस्तेमाल करने के बारे में भी बताया गया है.

1. Xcode में, अपना ऐप्लिकेशन प्रोजेक्ट खोलकर, फ़ाइल > पैकेज जोड़ें पर जाएं.
2. जब कहा जाए, तब Firebase के Apple प्लैटफ़ॉर्म के SDK टूल का रिपॉज़िटरी जोड़ें:

  https://github.com/firebase/firebase-ios-sdk.git

ध्यान दें: नए प्रोजेक्ट में, डिफ़ॉल्ट (नया) एसडीके वर्शन इस्तेमाल किया जाना चाहिए. हालांकि, ज़रूरत पड़ने पर, आपके पास पुराना वर्शन चुनने का विकल्प भी होता है.
3. Cloud Functions लाइब्रेरी चुनें.
4. अपने टारगेट की बिल्ड सेटिंग के अन्य लिंकर फ़्लैग सेक्शन में -ObjC फ़्लैग जोड़ें.
5. प्रोसेस पूरी होने के बाद, Xcode बैकग्राउंड में आपकी डिपेंडेंसी को अपने-आप हल और डाउनलोड करना शुरू कर देगा.

Web

1. अपने वेब ऐप्लिकेशन में Firebase जोड़ने के लिए, निर्देशों का पालन करें. अपने टर्मिनल से यह कमांड ज़रूर चलाएं:

   npm install firebase@11.7.1 --save

2. Firebase के कोर और Cloud Functions, दोनों को मैन्युअल रूप से ज़रूरी के तौर पर सेट करें:

    import { initializeApp } from 'firebase/app';
    import { getFunctions } from 'firebase/functions';
   
    const app = initializeApp({
        projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
        apiKey: '### FIREBASE API KEY ###',
        authDomain: '### FIREBASE AUTH DOMAIN ###',
      });
    const functions = getFunctions(app);

Web

1. अपने वेब ऐप्लिकेशन में Firebase जोड़ने के लिए, निर्देशों का पालन करें.
2. अपने ऐप्लिकेशन में Firebase कोर और Cloud Functions क्लाइंट लाइब्रेरी जोड़ें:

   <script src="https://www.gstatic.com/firebasejs/8.10.1/firebase.js"></script>
   <script src="https://www.gstatic.com/firebasejs/8.10.1/firebase-functions.js"></script>

Cloud Functions SDK टूल, एनपीएम पैकेज के तौर पर भी उपलब्ध है.

1. अपने टर्मिनल से यह कमांड चलाएं:

   npm install firebase@8.10.1 --save

2. Firebase के कोर और Cloud Functions, दोनों को मैन्युअल रूप से ज़रूरी के तौर पर सेट करें:

   const firebase = require("firebase");
   // Required for side-effects
   require("firebase/functions");

Kotlin

1. अपने Android ऐप्लिकेशन में Firebase जोड़ने के लिए, निर्देशों का पालन करें.

2. अपनी मॉड्यूल (ऐप्लिकेशन-लेवल) Gradle फ़ाइल (आम तौर पर <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle) में, Android के लिए Cloud Functions लाइब्रेरी की डिपेंडेंसी जोड़ें. हमारा सुझाव है कि लाइब्रेरी के वर्शन को कंट्रोल करने के लिए, Firebase Android BoM का इस्तेमाल करें.

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.13.0"))
   
       // Add the dependency for the Cloud Functions library
       // When using the BoM, you don't specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-functions")
   }

   Firebase Android BoM का इस्तेमाल करने पर, आपका ऐप्लिकेशन हमेशा Firebase Android लाइब्रेरी के काम करने वाले वर्शन का इस्तेमाल करेगा.

   (विकल्प)  BoM का इस्तेमाल किए बिना Firebase लाइब्रेरी की डिपेंडेंसी जोड़ें

   अगर Firebase BoM का इस्तेमाल नहीं किया जाता है, तो आपको हर Firebase लाइब्रेरी के वर्शन की जानकारी, उसकी डिपेंडेंसी लाइन में देनी होगी.

   ध्यान दें कि अगर आपके ऐप्लिकेशन में एक से ज़्यादा Firebase लाइब्रेरी का इस्तेमाल किया जाता है, तो हमारा सुझाव है कि आप लाइब्रेरी के वर्शन मैनेज करने के लिए BoM का इस्तेमाल करें. इससे यह पक्का होता है कि सभी वर्शन काम करते हों.

   dependencies {
       // Add the dependency for the Cloud Functions library
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-functions:21.2.1")
   }

   क्या आपको Kotlin के लिए कोई लाइब्रेरी मॉड्यूल चाहिए? अक्टूबर 2023 (Firebase BoM 32.5.0) से, Kotlin और Java, दोनों डेवलपर मुख्य लाइब्रेरी मॉड्यूल का इस्तेमाल कर सकते हैं. ज़्यादा जानकारी के लिए, इस पहल के बारे में अक्सर पूछे जाने वाले सवाल देखें.

Java

1. अपने Android ऐप्लिकेशन में Firebase जोड़ने के लिए, निर्देशों का पालन करें.

2. अपनी मॉड्यूल (ऐप्लिकेशन-लेवल) Gradle फ़ाइल (आम तौर पर <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle) में, Android के लिए Cloud Functions लाइब्रेरी की डिपेंडेंसी जोड़ें. हमारा सुझाव है कि लाइब्रेरी के वर्शन को कंट्रोल करने के लिए, Firebase Android BoM का इस्तेमाल करें.

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.13.0"))
   
       // Add the dependency for the Cloud Functions library
       // When using the BoM, you don't specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-functions")
   }

   Firebase Android BoM का इस्तेमाल करने पर, आपका ऐप्लिकेशन हमेशा Firebase Android लाइब्रेरी के काम करने वाले वर्शन का इस्तेमाल करेगा.

   (विकल्प)  BoM का इस्तेमाल किए बिना Firebase लाइब्रेरी की डिपेंडेंसी जोड़ें

   अगर Firebase BoM का इस्तेमाल नहीं किया जाता है, तो आपको हर Firebase लाइब्रेरी के वर्शन की जानकारी, उसकी डिपेंडेंसी लाइन में देनी होगी.

   ध्यान दें कि अगर आपके ऐप्लिकेशन में एक से ज़्यादा Firebase लाइब्रेरी का इस्तेमाल किया जाता है, तो हमारा सुझाव है कि आप लाइब्रेरी के वर्शन मैनेज करने के लिए BoM का इस्तेमाल करें. इससे यह पक्का होता है कि सभी वर्शन काम करते हों.

   dependencies {
       // Add the dependency for the Cloud Functions library
       // When NOT using the BoM, you must specify versions in Firebase library dependencies
       implementation("com.google.firebase:firebase-functions:21.2.1")
   }

   क्या आपको Kotlin के लिए कोई लाइब्रेरी मॉड्यूल चाहिए? अक्टूबर 2023 (Firebase BoM 32.5.0) से, Kotlin और Java, दोनों डेवलपर मुख्य लाइब्रेरी मॉड्यूल का इस्तेमाल कर सकते हैं. ज़्यादा जानकारी के लिए, इस पहल के बारे में अक्सर पूछे जाने वाले सवाल देखें.

Dart

1. अपने Flutter ऐप्लिकेशन में Firebase जोड़ने के लिए, निर्देशों का पालन करें.

2. प्लग इन इंस्टॉल करने के लिए, अपने Flutter प्रोजेक्ट के रूट से यह कमांड चलाएं:

   flutter pub add cloud_functions
   

3. इसके बाद, अपना Flutter ऐप्लिकेशन फिर से बनाएं:

   flutter run
   

4. इंस्टॉल करने के बाद, cloud_functions प्लग इन को अपने Dart कोड में इंपोर्ट करके ऐक्सेस किया जा सकता है:

   import 'package:cloud_functions/cloud_functions.dart';
   

C++

Android के साथ C++ के लिए:

1. अपने C++ प्रोजेक्ट में Firebase जोड़ने के लिए, निर्देशों का पालन करें.
2. अपनी CMakeLists.txt फ़ाइल में firebase_functions लाइब्रेरी जोड़ें.

Apple प्लैटफ़ॉर्म के साथ C++ के लिए:

1. अपने C++ प्रोजेक्ट में Firebase जोड़ने के लिए, निर्देशों का पालन करें.
2. अपने Podfile में Cloud Functions पॉड जोड़ें:

   pod 'Firebase/Functions'

3. फ़ाइल सेव करें. इसके बाद, यह चलाएं:

   pod install

4. अपने Xcode प्रोजेक्ट में, Firebase C++ SDK टूल से Firebase कोर और Cloud Functions फ़्रेमवर्क जोड़ें.
   • firebase.framework
   • firebase_functions.framework

Unity

1. अपने Unity प्रोजेक्ट में Firebase जोड़ने के लिए, निर्देशों का पालन करें.
2. अपने Unity प्रोजेक्ट में, Firebase Unity SDK टूल से FirebaseFunctions.unitypackage जोड़ें.

क्लाइंट SDK टूल को शुरू करना

Cloud Functions का इंस्टेंस शुरू करना:

Swift

lazy var functions = Functions.functions()
CloudAddCell.swift

Objective-C

@property(strong, nonatomic) FIRFunctions *functions;
// ...
self.functions = [FIRFunctions functions];
CloudAddCell.m

Web

firebase.initializeApp({
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###'
  databaseURL: 'https://### YOUR DATABASE NAME ###.firebaseio.com',
});

// Initialize Cloud Functions through Firebase
var functions = firebase.functions();

Web

const app = initializeApp({
  projectId: '### CLOUD FUNCTIONS PROJECT ID ###',
  apiKey: '### FIREBASE API KEY ###',
  authDomain: '### FIREBASE AUTH DOMAIN ###',
});
const functions = getFunctions(app);

Kotlin

private lateinit var functions: FirebaseFunctions
// ...
functions = Firebase.functions
MainActivity.kt

Java

private FirebaseFunctions mFunctions;
// ...
mFunctions = FirebaseFunctions.getInstance();
MainActivity.java

Dart

final functions = FirebaseFunctions.instance;

C++

firebase::functions::Functions* functions;
// ...
functions = firebase::functions::Functions::GetInstance(app);

Unity

functions = Firebase.Functions.DefaultInstance;

ध्यान दें: डिफ़ॉल्ट us-central1 के अलावा किसी भी जगह पर चल रहे फ़ंक्शन को कॉल करने के लिए, आपको शुरू करने के समय सही वैल्यू सेट करनी होगी. उदाहरण के लिए, Android पर आपको getInstance(FirebaseApp app, String region) से शुरू करना होगा.

फ़ंक्शन को कॉल करना

Swift

functions.httpsCallable("addMessage").call(["text": inputField.text]) { result, error in
  if let error = error as NSError? {
    if error.domain == FunctionsErrorDomain {
      let code = FunctionsErrorCode(rawValue: error.code)
      let message = error.localizedDescription
      let details = error.userInfo[FunctionsErrorDetailsKey]
    }
    // ...
  }
  if let data = result?.data as? [String: Any], let text = data["text"] as? String {
    self.resultField.text = text
  }
}
CommentCell.swift

Objective-C

[[_functions HTTPSCallableWithName:@"addMessage"] callWithObject:@{@"text": _inputField.text}
                                                      completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
  if (error) {
    if ([error.domain isEqual:@"com.firebase.functions"]) {
      FIRFunctionsErrorCode code = error.code;
      NSString *message = error.localizedDescription;
      NSObject *details = error.userInfo[@"details"];
    }
    // ...
  }
  self->_resultField.text = result.data[@"text"];
}];

Web

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  });
callable.js

Web

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  });
fb_functions_call_add_message.js

Kotlin

private fun addMessage(text: String): Task<String> {
    // Create the arguments to the callable function.
    val data = hashMapOf(
        "text" to text,
        "push" to true,
    )

    return functions
        .getHttpsCallable("addMessage")
        .call(data)
        .continueWith { task ->
            // This continuation runs on either success or failure, but if the task
            // has failed then result will throw an Exception which will be
            // propagated down.
            val result = task.result?.data as String
            result
        }
}
MainActivity.kt

Java

private Task<String> addMessage(String text) {
    // Create the arguments to the callable function.
    Map<String, Object> data = new HashMap<>();
    data.put("text", text);
    data.put("push", true);

    return mFunctions
            .getHttpsCallable("addMessage")
            .call(data)
            .continueWith(new Continuation<HttpsCallableResult, String>() {
                @Override
                public String then(@NonNull Task<HttpsCallableResult> task) throws Exception {
                    // This continuation runs on either success or failure, but if the task
                    // has failed then getResult() will throw an Exception which will be
                    // propagated down.
                    String result = (String) task.getResult().getData();
                    return result;
                }
            });
}
MainActivity.java

Dart

    final result = await FirebaseFunctions.instance.httpsCallable('addMessage').call(
      {
        "text": text,
        "push": true,
      },
    );
    _response = result.data as String;

C++

firebase::Future<firebase::functions::HttpsCallableResult> AddMessage(
    const std::string& text) {
  // Create the arguments to the callable function.
  firebase::Variant data = firebase::Variant::EmptyMap();
  data.map()["text"] = firebase::Variant(text);
  data.map()["push"] = true;

  // Call the function and add a callback for the result.
  firebase::functions::HttpsCallableReference doSomething =
      functions->GetHttpsCallable("addMessage");
  return doSomething.Call(data);
}

Unity

private Task<string> addMessage(string text) {
  // Create the arguments to the callable function.
  var data = new Dictionary<string, object>();
  data["text"] = text;
  data["push"] = true;

  // Call the function and extract the operation from the result.
  var function = functions.GetHttpsCallable("addMessage");
  return function.CallAsync(data).ContinueWith((task) => {
    return (string) task.Result.Data;
  });
}

क्लाइंट पर गड़बड़ियों को मैनेज करना

अगर सर्वर में कोई गड़बड़ी होती है या नतीजे के तौर पर मिलने वाले प्रॉमिस को अस्वीकार कर दिया जाता है, तो क्लाइंट को गड़बड़ी का मैसेज मिलता है.

अगर फ़ंक्शन से मिली गड़बड़ी function.https.HttpsError टाइप की है, तो क्लाइंट को सर्वर से गड़बड़ी code, message, और details मिलती है. अगर ऐसा नहीं है, तो गड़बड़ी में मैसेज INTERNAL और कोड INTERNAL शामिल होगा. कॉल किए जा सकने वाले फ़ंक्शन में, गड़बड़ियों को मैनेज करने का तरीका जानें.

Swift

if let error = error as NSError? {
  if error.domain == FunctionsErrorDomain {
    let code = FunctionsErrorCode(rawValue: error.code)
    let message = error.localizedDescription
    let details = error.userInfo[FunctionsErrorDetailsKey]
  }
  // ...
}
CloudAddCell.swift

Objective-C

if (error) {
  if ([error.domain isEqual:@"com.firebase.functions"]) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[@"details"];
  }
  // ...
}
CloudAddCell.m

Web

var addMessage = firebase.functions().httpsCallable('addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    var sanitizedMessage = result.data.text;
  })
  .catch((error) => {
    // Getting the Error details.
    var code = error.code;
    var message = error.message;
    var details = error.details;
    // ...
  });
callable.js

Web

import { getFunctions, httpsCallable } from "firebase/functions";

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage');
addMessage({ text: messageText })
  .then((result) => {
    // Read result of the Cloud Function.
    /** @type {any} */
    const data = result.data;
    const sanitizedMessage = data.text;
  })
  .catch((error) => {
    // Getting the Error details.
    const code = error.code;
    const message = error.message;
    const details = error.details;
    // ...
  });
fb_functions_call_add_message_error.js

Kotlin

addMessage(inputMessage)
    .addOnCompleteListener { task ->
        if (!task.isSuccessful) {
            val e = task.exception
            if (e is FirebaseFunctionsException) {
                val code = e.code
                val details = e.details
            }
        }
    }
MainActivity.kt

Java

addMessage(inputMessage)
        .addOnCompleteListener(new OnCompleteListener<String>() {
            @Override
            public void onComplete(@NonNull Task<String> task) {
                if (!task.isSuccessful()) {
                    Exception e = task.getException();
                    if (e instanceof FirebaseFunctionsException) {
                        FirebaseFunctionsException ffe = (FirebaseFunctionsException) e;
                        FirebaseFunctionsException.Code code = ffe.getCode();
                        Object details = ffe.getDetails();
                    }
                }
            }
        });
MainActivity.java

Dart

try {
  final result =
      await FirebaseFunctions.instance.httpsCallable('addMessage').call();
} on FirebaseFunctionsException catch (error) {
  print(error.code);
  print(error.details);
  print(error.message);
}

C++

void OnAddMessageCallback(
    const firebase::Future<firebase::functions::HttpsCallableResult>& future) {
  if (future.error() != firebase::functions::kErrorNone) {
    // Function error code, will be kErrorInternal if the failure was not
    // handled properly in the function call.
    auto code = static_cast<firebase::functions::Error>(future.error());

    // Display the error in the UI.
    DisplayError(code, future.error_message());
    return;
  }

  const firebase::functions::HttpsCallableResult* result = future.result();
  firebase::Variant data = result->data();
  // This will assert if the result returned from the function wasn't a string.
  std::string message = data.string_value();
  // Display the result in the UI.
  DisplayResult(message);
}

// ...

// ...
  auto future = AddMessage(message);
  future.OnCompletion(OnAddMessageCallback);
  // ...

Unity

 addMessage(text).ContinueWith((task) => {
  if (task.IsFaulted) {
    foreach (var inner in task.Exception.InnerExceptions) {
      if (inner is FunctionsException) {
        var e = (FunctionsException) inner;
        // Function error code, will be INTERNAL if the failure
        // was not handled properly in the function call.
        var code = e.ErrorCode;
        var message = e.ErrorMessage;
      }
    }
  } else {
    string result = task.Result;
  }
});

सुझाव: App Check की मदद से, गलत इस्तेमाल को रोकना

ऐप्लिकेशन लॉन्च करने से पहले, आपको App Check को चालू करना चाहिए. इससे यह पक्का करने में मदद मिलेगी कि सिर्फ़ आपके ऐप्लिकेशन, कॉल किए जा सकने वाले फ़ंक्शन के एंडपॉइंट को ऐक्सेस कर सकते हैं.