Google is committed to advancing racial equity for Black communities. See how.
इस पेज का अनुवाद Cloud Translation API से किया गया है.
Switch to English

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

Firebase क्लाइंट SDKs के लिए क्लाउड फ़ंक्शंस आपको Firebase ऐप से सीधे फ़ंक्शन कॉल करने देता है। इस तरह से अपने ऐप से फ़ंक्शन को कॉल करने के लिए, क्लाउड फ़ंक्शंस में HTTPS Callable फ़ंक्शन को लिखें और तैनात करें, और फिर अपने ऐप से फ़ंक्शन को कॉल करने के लिए क्लाइंट लॉजिक जोड़ें।

यह ध्यान रखना महत्वपूर्ण है कि HTTPS कॉल करने योग्य फ़ंक्शन समान हैं लेकिन HTTP फ़ंक्शन के समान नहीं हैं । HTTPS प्रतिदेय कार्यों का उपयोग करने के लिए आप ग्राहक एसडीके अपने मंच के लिए एक साथ के साथ उपयोग करना चाहिए functions.https बैकएंड API (या प्रोटोकॉल लागू)। कॉलबल्स में HTTP फ़ंक्शन से ये महत्वपूर्ण अंतर हैं:

  • कॉलबेल के साथ, जब उपलब्ध हो, फायरबेस प्रमाणीकरण और एफसीएम टोकन स्वचालित रूप से अनुरोधों में शामिल हैं।
  • functions.https.onCall .https.onCall ट्रिगर स्वचालित रूप से अनुरोध निकाय को दिखाता है और ऑर्किटेक्ट टोकन को मान्य करता है।

क्लाउड फ़ंक्शंस v0.9.1 के लिए Firebase SDK और HTTPS Callable फ़ंक्शन का समर्थन करने के लिए इन Firebase क्लाइंट SDK न्यूनतम संस्करणों के साथ उच्च इंटरऑप्टर:

  • आईओएस 6.32.2 के लिए फायरबेस एसडीके
  • एंड्रॉइड 19.1.0 के लिए फायरबेस एसडीके
  • फायरबेस जावास्क्रिप्ट एसडीके 7.21.0

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

कॉल करने योग्य फ़ंक्शन लिखें और तैनात करें

HTTPS कॉल करने योग्य फ़ंक्शन बनाने के लिए 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) => {
  // ...
});

एक कॉल करने योग्य फ़ंक्शन के लिए जो रियलटाइम डेटाबेस के लिए एक टेक्स्ट संदेश बचाता है, उदाहरण के लिए, data में संदेश पाठ हो सकता है, जबकि context पैरामीटर उपयोगकर्ता की सामान्य जानकारी का प्रतिनिधित्व करते हैं:

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

कॉल करने योग्य फ़ंक्शन के स्थान और कॉलिंग क्लाइंट के स्थान के बीच की दूरी नेटवर्क विलंबता बना सकती है। प्रदर्शन का अनुकूलन करने के लिए, जहां लागू हो, फ़ंक्शन स्थान को निर्दिष्ट करने पर विचार करें, और क्लाइंट साइड पर एसडीके को इनिशियलाइज़ करने पर स्थान सेट के साथ कॉल करने योग्य स्थान को संरेखित करना सुनिश्चित करें।

परिणाम वापस भेज रहा हूं

ग्राहक को डेटा वापस भेजने के लिए, JSON एनकोडेड डेटा वापस कर सकते हैं। उदाहरण के लिए, एक अतिरिक्त ऑपरेशन के परिणाम को वापस करने के लिए:

// returning result.
return {
  firstNumber: firstNumber,
  secondNumber: secondNumber,
  operator: '+',
  operationResult: firstNumber + secondNumber,
};

एक अतुल्यकालिक ऑपरेशन के बाद डेटा वापस करने के लिए, एक वादा वापस करें। वादा द्वारा लौटाए गए डेटा को क्लाइंट को वापस भेज दिया जाता है। उदाहरण के लिए, आप संचित पाठ को लौटा सकते हैं जिसे कॉल करने योग्य फ़ंक्शन ने रियलटाइम डेटाबेस को लिखा था:

// Saving the new message to the Realtime Database.
const sanitizedMessage = sanitizer.sanitizeText(text); // Sanitize the message.
return admin.database().ref('/messages').push({
  text: sanitizedMessage,
  author: { uid, name, picture, email },
}).then(() => {
  console.log('New Message written');
  // Returning the sanitized message to the client.
  return { text: sanitizedMessage };
})

त्रुटियों को संभालें

यह सुनिश्चित करने के लिए कि क्लाइंट को उपयोगी त्रुटि विवरण मिले, functions.https.HttpsError एक उदाहरण को फेंकने से (या अस्वीकार किए गए एक वादे) को कॉल करने से त्रुटियों को लौटाएं ।https.HttpsError। त्रुटि में एक code विशेषता होती है, जो functions.https.HttpsError .https.HttpsError पर सूचीबद्ध मानों में से एक हो सकती functions.https.HttpsError । त्रुटियों में एक स्ट्रिंग message भी होता है, जो एक खाली स्ट्रिंग को डिफॉल्ट करता है। वे एक मनमाना मूल्य के साथ एक वैकल्पिक details क्षेत्र भी रख सकते हैं। यदि आपके कार्यों से HttpsError अलावा कोई त्रुटि 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 functions.https.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 (!context.auth) {
  // Throwing an HttpsError so that the client gets the error details.
  throw new functions.https.HttpsError('failed-precondition', 'The function must be called ' +
      'while authenticated.');
}

कॉल करने योग्य फ़ंक्शन को तैनात करें

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

$ firebase deploy --only functions:addMessage

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

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

सुनिश्चित करें कि आप किसी भी आवश्यक शर्तें को पूरा करते हैं, फिर अपने ऐप में आवश्यक निर्भरताएं और क्लाइंट लाइब्रेरी जोड़ें।

आईओएस

  1. अपने आईओएस ऐप में फायरबेस जोड़ने के निर्देशों का पालन करें।
  2. अपने Podfile में क्लाउड फ़ंक्शंस पॉड जोड़ें:
    pod 'Firebase/Functions'
  3. फ़ाइल सहेजें, फिर चलाएँ:
    pod install

वेब

  1. अपने वेब ऐप में फायरबेस जोड़ने के निर्देशों का पालन करें।
  2. अपने ऐप में फायरबेस कोर और क्लाउड फ़ंक्शंस क्लाइंट लाइब्रेरी जोड़ें:
    <script src="https://www.gstatic.com/firebasejs/7.21.0/firebase.js"></script>
    <script src="https://www.gstatic.com/firebasejs/7.21.0/firebase-functions.js"></script>
    

क्लाउड फ़ंक्शंस SDK एक npm पैकेज के रूप में भी उपलब्ध है।

  1. अपने टर्मिनल से निम्न कमांड चलाएँ:
    npm install firebase@7.21.0 --save
    
  2. मैन्युअल रूप से फायरबेस कोर और क्लाउड फ़ंक्शंस दोनों की आवश्यकता होती है:
    const firebase = require("firebase");
    // Required for side-effects
    require("firebase/functions");
    

जावा

  1. अपने Android ऐप में Firebase जोड़ने के निर्देशों का पालन करें।
  2. अपने प्रोजेक्ट-लेवल build.gradle फ़ाइल में, अपने buildscript और allprojects दोनों वर्गों में Google के buildscript रिपॉजिटरी को शामिल करना सुनिश्चित करें।
  3. क्लाउड फ़ंक्शंस की एंड्रॉइड लाइब्रेरी के लिए निर्भरता को अपने मॉड्यूल (ऐप-स्तर) ग्रेड फ़ाइल में जोड़ें (आमतौर पर app/build.gradle ):
    implementation 'com.google.firebase:firebase-functions:19.1.0'
    

Kotlin + KTX

  1. अपने Android ऐप में Firebase जोड़ने के निर्देशों का पालन करें।
  2. अपने प्रोजेक्ट-लेवल build.gradle फ़ाइल में, अपने buildscript और allprojects दोनों वर्गों में Google के buildscript रिपॉजिटरी को शामिल करना सुनिश्चित करें।
  3. क्लाउड फ़ंक्शंस के लिए निर्भरता जोड़ें Android लाइब्रेरी को अपने मॉड्यूल (ऐप-स्तर) ग्रेड फ़ाइल (आमतौर पर app/build.gradle ): Ce67f8c0d9

सी ++

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

  1. अपने C ++ प्रोजेक्ट में Firebase जोड़ने के निर्देशों का पालन करें।
  2. अपने प्रोजेक्ट-लेवल build.gradle फ़ाइल में, अपने buildscript और allprojects दोनों वर्गों में Google के buildscript रिपॉजिटरी को शामिल करना सुनिश्चित करें।
  3. अपने CMakeLists.txt फ़ाइल में firebase_functions लाइब्रेरी जोड़ें।

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

  1. अपने C ++ प्रोजेक्ट में Firebase जोड़ने के निर्देशों का पालन करें।
  2. अपने Podfile में क्लाउड फ़ंक्शंस पॉड जोड़ें:
    pod 'Firebase/Functions'
  3. फ़ाइल सहेजें, फिर चलाएँ:
    pod install
  4. अपने Xcode प्रोजेक्ट में Firebase C ++ SDK से फायरबेस कोर और क्लाउड फ़ंक्शंस फ्रेमवर्क जोड़ें।
    • firebase.framework
    • firebase_functions.framework

एकता

  1. अपने एकता प्रोजेक्ट में फायरबेस जोड़ने के निर्देशों का पालन करें।
  2. जोड़े FirebaseFunctions.unitypackage से Firebase एकता एसडीके अपने एकता परियोजना के लिए।

क्लाइंट SDK को इनिशियलाइज़ करें

क्लाउड फ़ंक्शंस का एक उदाहरण प्रारंभ करें:

तीव्र

lazy var functions = Functions.functions()

उद्देश्य सी

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

वेब

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();

जावा

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

Kotlin + KTX

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

सी ++

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

एकता

functions = Firebase.Functions.DefaultInstance;

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

तीव्र

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 text = (result?.data as? [String: Any])?["text"] as? String {
    self.resultField.text = text
  }
}

उद्देश्य सी

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

वेब

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

जावा

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;
                }
            });
}

Kotlin + KTX

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
            }
}

सी ++

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);
}

एकता

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 । अपने कॉल करने योग्य फ़ंक्शन में त्रुटियों को कैसे प्रबंधित करें, इसके लिए मार्गदर्शन देखें।

तीव्र

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 (error) {
  if (error.domain == FIRFunctionsErrorDomain) {
    FIRFunctionsErrorCode code = error.code;
    NSString *message = error.localizedDescription;
    NSObject *details = error.userInfo[FIRFunctionsErrorDetailsKey];
  }
  // ...
}

वेब

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

जावा

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();
                    }

                    // ...
                }

                // ...
            }
        });

Kotlin + KTX

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

                // ...
            }

            // ...
        })

सी ++

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);
// ...

एकता

 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;
  }
});