আপনার অ্যাপ থেকে কল ফাংশন (১ম জেনারেশন)

Cloud Functions for Firebase ক্লায়েন্ট SDK আপনাকে সরাসরি Firebase অ্যাপ থেকে ফাংশন কল করতে দেয়। আপনার অ্যাপ থেকে এইভাবে ফাংশন কল করতে, Cloud Functions-এ HTTP কল করা যায় এমন ফাংশন লিখুন ও ডিপ্লয় করুন, তারপর আপনার অ্যাপ থেকে ফাংশন কল করার জন্য ক্লায়েন্ট লজিক যোগ করুন।

মনে রাখবেন, HTTP কল করা যায় এমন ফাংশন HTTP ফাংশনের মতো হলেও একই নয়। HTTP কল করা যায় এমন ফাংশন ব্যবহার করতে হলে আপনাকে অবশ্যই ব্যাকএন্ড API-এর সাথে আপনার প্ল্যাটফর্মের জন্য ক্লায়েন্ট SDK ব্যবহার করতে হবে (অথবা প্রোটোকল প্রয়োগ করতে হবে)। HTTP ফাংশন থেকে কলযোগ্য ফাংশনের এইসব মূল পার্থক্য রয়েছে:

  • কল করার যোগ্য ফাংশনের ক্ষেত্রে, Firebase Authentication টোকেন, FCM টোকেন এবং App Check টোকেন, উপলভ্য থাকলে, অনুরোধে অটোমেটিক অন্তর্ভুক্ত করা হয়।
  • ট্রিগার অটোমেটিক অনুরোধের বডি ডিসিরিয়ালাইজ করে এবং যাচাইকরণ টোকেন যাচাই করে।

Firebase SDK for Cloud Functions ২য় জেনারেশন এবং তার পরবর্তী ভার্সনগুলি এই Firebase ক্লায়েন্ট SDK-এর ন্যূনতম ভার্সনের সাথে ইন্টারঅপারেট করে যাতে HTTPS কলযোগ্য ফাংশনগুলি কাজ করে:

  • Apple প্ল্যাটফর্মের জন্য Firebase SDK 13.0.0
  • Android 23.0.0-এর জন্য Firebase SDK
  • Firebase Modular Web SDK v. 9.7.0

আপনি যদি কাজ করে না এমন প্ল্যাটফর্মে তৈরি অ্যাপে একই ধরনের কার্যকারিতা যোগ করতে চান, তাহলে https.onCall-এর জন্য প্রোটোকল স্পেসিফিকেশন দেখুন। এই গাইডের বাকি অংশে Apple প্ল্যাটফর্ম, Android, ওয়েব, C++ এবং Unity-র জন্য HTTP কল করা যায় এমন ফাংশন কীভাবে লিখতে, ডিপ্লয় করতে এবং কল করতে হয় সেই বিষয়ে নির্দেশাবলী দেওয়া আছে।

কল করা যায় এমন ফাংশন লিখুন ও ডিপ্লয় করুন

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

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;

কল করা যায় এমন ফাংশনের লোকেশন এবং কলিং ক্লায়েন্টের লোকেশনের মধ্যে দূরত্ব নেটওয়ার্ক লেটেন্সি তৈরি করতে পারে। পারফর্ম্যান্স অপ্টিমাইজ করতে, যেখানে প্রযোজ্য সেখানে ফাংশন লোকেশন নির্দিষ্ট করার কথা বিবেচনা করুন এবং ক্লায়েন্ট সাইডে SDK শুরু করার সময় কল করা যায় এমন লোকেশন, সেট করা লোকেশনের সাথে অ্যালাইন করতে ভুলবেন না।

বিকল্প হিসেবে, বিলিং সংক্রান্ত প্রতারণা বা ফিশিংয়ের মতো অপব্যবহার থেকে আপনার ব্যাকএন্ড রিসোর্সকে সুরক্ষিত রাখতে সাহায্য করার জন্য আপনি App Check অ্যাটেস্টেশন অ্যাটাচ করতে পারেন। Cloud Functions-এর জন্য App Check এনফোর্সমেন্ট চালু করুন দেখুন।

ফলাফল ফেরত পাঠানো হচ্ছে

ক্লায়েন্টের কাছে ডেটা ফেরত পাঠাতে, JSON এনকোড করা যায় এমন ডেটা ফেরত পাঠান। যেমন, যোগ করার অপারেশনের ফলাফল রিটার্ন করতে:

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

অ্যাসিঙ্ক্রোনাস অপারেশনের পরে ডেটা ফেরত দিতে, একটি প্রমিস ফেরত দিন। প্রমিজের মাধ্যমে ফেরত পাঠানো ডেটা ক্লায়েন্টের কাছে ফেরত পাঠানো হয়। যেমন, আপনি কল করা যায় এমন ফাংশন 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};
})

সমস্যা ম্যানেজ করা

ক্লায়েন্ট যাতে সমস্যার বিবরণ পান তা নিশ্চিত করতে, 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-এর মধ্যে সম্পূর্ণ কল করা যায় এমন ফাংশন সেভ করার পরে, firebase deploy রান করার সময় অন্যান্য সব ফাংশনের সাথে এটি ডিপ্লয় করা হয়। শুধুমাত্র কল করা যায় এমন ফাংশন ডিপ্লয় করতে, --only আর্গুমেন্ট ব্যবহার করুন, যেমনটি আংশিক ডিপ্লয় করার জন্য দেখানো হয়েছে:

firebase deploy --only functions:addMessage

ফাংশন ডিপ্লয় করার সময় অনুমতি সংক্রান্ত কোনও সমস্যা হলে, ডিপ্লয়মেন্ট কমান্ড রান করা ব্যবহারকারীকে উপযুক্ত IAM ভূমিকা অ্যাসাইন করা হয়েছে কিনা তা নিশ্চিত করুন।

আপনার ক্লায়েন্ট ডেভেলপমেন্ট এনভায়রনমেন্ট সেট-আপ করুন

আপনি সব পূর্বশর্ত পূরণ করেছেন কিনা তা ভালো করে দেখে নিন, তারপর আপনার অ্যাপে প্রয়োজনীয় ডিপেন্ডেন্সি ও ক্লায়েন্ট লাইব্রেরি যোগ করুন।

iOS+

আপনার Apple অ্যাপে Firebase যোগ করতে নির্দেশাবলী অনুসরণ করুন।

Firebase ডিপেন্ডেন্সি ইনস্টল ও ম্যানেজ করতে Swift প্যাকেজ ম্যানেজার ব্যবহার করুন।

  1. Xcode-এ, আপনার অ্যাপ প্রোজেক্ট খোলা রেখে, ফাইল > প্যাকেজ যোগ করুন বিকল্পে নেভিগেট করুন।
  2. প্রম্পট করা হলে, Firebase Apple প্ল্যাটফর্ম SDK রিপোজিটরি যোগ করুন:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. Cloud Functions লাইব্রেরি বেছে নিন।
  5. আপনার টার্গেটের বিল্ড সেটিংসের অন্যান্য লিঙ্কার ফ্ল্যাগ বিভাগে -ObjC ফ্ল্যাগ যোগ করুন।
  6. হয়ে গেলে, Xcode অটোমেটিক ব্যাকগ্রাউন্ডে আপনার ডিপেন্ডেন্সি সমাধান ও ডাউনলোড করা শুরু করবে।

Web

  1. আপনার ওয়েব অ্যাপে Firebase যোগ করতে নির্দেশাবলী অনুসরণ করুন। আপনার টার্মিনাল থেকে নিম্নলিখিত কমান্ড রান করতে ভুলবেন না:
    npm install firebase@13.0.0 --save
  2. Firebase core এবং 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, npm প্যাকেজ হিসেবেও উপলভ্য।

  1. আপনার টার্মিনাল থেকে নিম্নলিখিত কমান্ড রান করুন:
    npm install firebase@8.10.1 --save
  2. Firebase core এবং 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:35.0.2"))
    
        // 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:23.0.0")
    }

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:35.0.2"))
    
        // 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:23.0.0")
    }

Dart

  1. আপনার Flutter অ্যাপে Firebase যোগ করতে নির্দেশাবলী অনুসরণ করুন।

  2. প্লাগ-ইন ইনস্টল করতে আপনার Flutter প্রোজেক্টের রুট থেকে নিম্নলিখিত কমান্ড রান করুন:

    flutter pub add cloud_functions
    
  3. সম্পূর্ণ হয়ে গেলে, আপনার Flutter অ্যাপ্লিকেশন আবার তৈরি করুন:

    flutter run
    
  4. ইনস্টল করা হয়ে গেলে, আপনি Dart কোডে ইমপোর্ট করে cloud_functions প্লাগ-ইন অ্যাক্সেস করতে পারবেন:

    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 কোর এবং Cloud Functions ফ্রেমওয়ার্ক Firebase C++ SDK থেকে যোগ করুন।
    • 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()

Objective-C

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

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

Java

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

Dart

final functions = FirebaseFunctions.instance;

C++

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

Unity

functions = Firebase.Functions.DefaultInstance;

ফাংশন কল করুন

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

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

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

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

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

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]
  }
  // ...
}

Objective-C

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

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

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

Kotlin

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

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

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

ক্লায়েন্ট টাইমআউট সেট করুন

ডিফল্ট হিসেবে, Cloud Functions ক্লায়েন্ট SDK, কল করা যায় এমন অনুরোধের জন্য ৭০-সেকেন্ডের টাইমআউট ব্যবহার করে। কোনও কল করা যায় এমন ফাংশন সম্পূর্ণ হতে ৭০ সেকেন্ডের বেশি সময় লাগলে, ক্লায়েন্ট SDK DEADLINE_EXCEEDED (deadline-exceeded) সমস্যার সাথে অনুরোধটি বাতিল করে দেয়—এমনকি আপনি সার্ভার-সাইড টাইমআউট আরও বেশি সময়ের জন্য কনফিগার করলেও।

দীর্ঘ সময় ধরে চলা কল করা যায় এমন ফাংশন সাপোর্ট করতে, আপনাকে সার্ভার ও ক্লায়েন্ট উভয় ক্ষেত্রেই টাইমআউট বাড়াতে হবে:

  1. সার্ভার-সাইড ফাংশন টাইম-আউট বাড়ান (টাইম-আউট ও মেমরি অ্যালোকেশন সেট করুন দেখুন)।
  2. আপনার অ্যাপে কল করা যায় এমন রেফারেন্স কনফিগার করার সময় ক্লায়েন্ট-সাইড টাইম-আউট বাড়ান:

Swift

let callable = functions.httpsCallable("addMessage")
callable.timeoutInterval = 300  // 300 seconds (default is 70)
let result = try await callable.call(["text": text, "push": true])

Objective-C

FIRHTTPSCallable *callable = [self.functions HTTPSCallableWithName:@"addMessage"];
callable.timeoutInterval = 300;  // 300 seconds (default is 70)
[callable callWithObject:@{@"text": text, @"push": @YES}
              completion:^(FIRHTTPSCallableResult * _Nullable result, NSError * _Nullable error) {
  // ...
}];

Web

var addMessage = firebase.functions().httpsCallable('addMessage', {
  timeout: 300000,  // 300 seconds in milliseconds (default is 70000)
});
addMessage({ text: messageText })
  .then((result) => {
    // ...
  });

Web

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

const functions = getFunctions();
const addMessage = httpsCallable(functions, 'addMessage', {
  timeout: 300000,  // 300 seconds in milliseconds (default is 70000)
});
const result = await addMessage({ text: messageText });

Kotlin

val callable = functions.getHttpsCallable("addMessage")
callable.setTimeout(300L, TimeUnit.SECONDS)
val result = callable.call(data).await()

Java

HttpsCallableReference callable = mFunctions.getHttpsCallable("addMessage");
callable.setTimeout(300L, TimeUnit.SECONDS);
Task<HttpsCallableResult> result = callable.call(data);

Dart

final callable = FirebaseFunctions.instance.httpsCallable(
  'addMessage',
  options: HttpsCallableOptions(
    timeout: const Duration(seconds: 300),
  ),
);
final result = await callable.call({
  'text': text,
  'push': true,
});

সাজেস্ট করা হয়েছে: App Check-এর মাধ্যমে অপব্যবহার প্রতিরোধ করুন

আপনার অ্যাপ লঞ্চ করার আগে, আপনাকে App Check চালু করতে হবে যাতে শুধুমাত্র আপনার অ্যাপই আপনার কল করা যায় এমন ফাংশন এন্ডপয়েন্ট অ্যাক্সেস করতে পারে।