קריאה לפונקציות מהאפליקציה

דור שני דור ראשון

ערכות ה-SDK של הלקוח Cloud Functions for Firebase מאפשרות לקרוא לפונקציות ישירות מאפליקציית Firebase. כדי לקרוא לפונקציה מהאפליקציה בדרך הזו, צריך לכתוב ולפרוס פונקציה שאפשר לקרוא לה באמצעות HTTP ב-Cloud Functions, ואז להוסיף לוגיקה של לקוח כדי לקרוא לפונקציה מהאפליקציה.

חשוב לזכור שפונקציות שאפשר להפעיל באמצעות HTTP דומות לפונקציות HTTP, אבל לא זהות להן. כדי להשתמש בפונקציות שאפשר להפעיל באמצעות HTTP, צריך להשתמש ב-Client SDK של הפלטפורמה שלכם יחד עם ה-API של ה-Backend (או להטמיע את הפרוטוקול). ההבדלים העיקריים בין פונקציות שאפשר להפעיל לבין פונקציות HTTP:

• כשמשתמשים בפונקציות שאפשר להפעיל, אסימוני Firebase Authentication, אסימוני FCM ואסימוני App Check, אם הם זמינים, נכללים אוטומטית בבקשות.
• הטריגר מבצע באופן אוטומטי דה-סריאליזציה של גוף הבקשה ומאמת את טוקני ההרשאה.

‫Firebase SDK ל-Cloud Functions דור שני ומעלה פועל בשילוב עם הגרסאות המינימליות הבאות של Firebase client SDK כדי לתמוך בפונקציות שאפשר להפעיל באמצעות HTTPS:

• ‫Firebase SDK for Apple platforms 12.0.0
• ‫Firebase SDK for Android 21.2.1
• Firebase Modular Web SDK v. 9.7.0

אם רוצים להוסיף פונקציונליות דומה לאפליקציה שנוצרה בפלטפורמה שלא נתמכת, אפשר לעיין במפרט הפרוטוקול של https.onCall. בהמשך המדריך מוסבר איך לכתוב, לפרוס ולהפעיל פונקציה שניתן להפעיל באמצעות HTTP בפלטפורמות של אפל, ב-Android, באינטרנט, ב-C++‎ וב-Unity.

כתיבה ופריסה של פונקציה שאפשר להפעיל

דוגמאות הקוד בקטע הזה מבוססות על דוגמה מלאה להפעלה מהירה שמראה איך לשלוח בקשות לפונקציה בצד השרת ולקבל תגובה באמצעות אחת מהערכות SDK של הלקוח. כדי להתחיל, מייבאים את המודולים הנדרשים:

Node.js

// Dependencies for callable functions.
const {onCall, HttpsError} = require("firebase-functions/v2/https");
const {logger} = require("firebase-functions/v2");

// Dependencies for the addMessage function.
const {getDatabase} = require("firebase-admin/database");
const sanitizer = require("./sanitizer");
index.js

Python

# Dependencies for callable functions.
from firebase_functions import https_fn, options

# Dependencies for writing to Realtime Database.
from firebase_admin import db, initialize_app
main.py

משתמשים ב-request handler של הפלטפורמה (functions.https.onCall או on_call) כדי ליצור פונקציה שאפשר להפעיל באמצעות HTTPS. השיטה הזו מקבלת פרמטר בקשה:

Node.js

// Saves a message to the Firebase Realtime Database but sanitizes the
// text by removing swearwords.
exports.addmessage = onCall((request) => {
  // ...
});
index.js

Python

@https_fn.on_call()
def addmessage(req: https_fn.CallableRequest) -> Any:
    """Saves a message to the Firebase Realtime Database but sanitizes the text
    by removing swear words."""
main.py

הפרמטר request מכיל נתונים שמועברים מאפליקציית הלקוח, וגם הקשר נוסף כמו מצב האימות. לדוגמה, אם יש פונקציה שאפשר להפעיל כדי לשמור הודעת טקסט ב-Realtime Database, הפרמטר data יכול להכיל את הטקסט של ההודעה, יחד עם פרטי אימות ב-auth:

Node.js

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

Python

# Message text passed from the client.
text = req.data["text"]
main.py
# Authentication / user information is automatically added to the request.
uid = req.auth.uid
name = req.auth.token.get("name", "")
picture = req.auth.token.get("picture", "")
email = req.auth.token.get("email", "")
main.py

המרחק בין המיקום של הפונקציה שאפשר להפעיל לבין המיקום של הלקוח שמפעיל אותה יכול ליצור זמן אחזור ברשת. כדי לשפר את הביצועים, כדאי לציין את מיקום הפונקציה במקרים הרלוונטיים, ולוודא שהמיקום של הפונקציה שניתן להפעלה תואם למיקום שהוגדר כשמפעילים את ה-SDK בצד הלקוח.

אפשר גם לצרף App Checkאישור כדי להגן על משאבי ה-Backend מפני ניצול לרעה, כמו הונאת חיוב או פישינג. במאמר הפעלת האכיפה של App Check ב-Cloud Functions מוסבר איך עושים את זה.

הערה: כדי לכתוב פונקציות שאפשר להפעיל, צריך להשתמש רק בממשקי ה-API של ה-Backend‏ functions.https או firebase_functions.https_fn. ‫HTTP trigger API הוא נפרד לחלוטין ואי אפשר להשתמש בו יחד עם פונקציות שאפשר להפעיל.

שליחת התוצאה בחזרה

כדי לשלוח נתונים חזרה ללקוח, צריך להחזיר נתונים שאפשר לקודד ב-JSON. לדוגמה, כדי להחזיר את התוצאה של פעולת חיבור:

Node.js

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

Python

return {
    "firstNumber": first_number,
    "secondNumber": second_number,
    "operator": "+",
    "operationResult": first_number + second_number
}
main.py

הטקסט שעבר סניטציה מהדוגמה של טקסט ההודעה מוחזר גם ללקוח וגם ל-Realtime Database. ב-Node.js, אפשר לעשות את זה באופן אסינכרוני באמצעות הבטחה (promise) של JavaScript:

Node.js

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

Python

# Saving the new message to the Realtime Database.
sanitized_message = sanitize_text(text)  # Sanitize message.
db.reference("/messages").push({  # type: ignore
    "text": sanitized_message,
    "author": {
        "uid": uid,
        "name": name,
        "picture": picture,
        "email": email
    }
})
print("New message written")

# Returning the sanitized message to the client.
return {"text": sanitized_message}
main.py

שליחה וקבלה של תוצאות סטרימינג

לפונקציות שאפשר להפעיל יש מנגנונים לטיפול בתוצאות סטרימינג. אם יש לכם תרחיש שימוש שדורש סטרימינג, אתם יכולים להגדיר סטרימינג בבקשה שאפשר להפעיל ואז להשתמש בשיטה המתאימה מתוך Client SDK כדי להפעיל את הפונקציה.

שליחת תוצאות של שידור

כדי להזרים ביעילות תוצאות שנוצרות לאורך זמן, למשל ממספר בקשות נפרדות ל-API או מ-API של AI גנרטיבי, צריך לבדוק את המאפיין acceptsStreaming בבקשה שאפשר להפעיל. אם מגדירים את המאפיין הזה לערך true, אפשר להזרים את התוצאות בחזרה ללקוח באמצעות response.sendChunk().

לדוגמה, אם אפליקציה צריכה לאחזר נתוני תחזית מזג אוויר לגבי כמה מיקומים, הפונקציה שאפשר להפעיל יכולה לשלוח את התחזית של כל מיקום בנפרד ללקוחות שביקשו תגובה בסטרימינג, במקום לגרום להם לחכות עד שכל בקשות התחזית יטופלו:

exports.getForecast = onCall(async (request, response) => {
  if (request.data?.locations?.length < 1) {
    throw new HttpsError("invalid-argument", "Missing locations to forecast");
  }

  // fetch forecast data for all requested locations
  const allRequests = request.data.locations.map(
      async ({latitude, longitude}) => {
        const forecast = await weatherForecastApi(latitude, longitude);
        const result = {latitude, longitude, forecast};

        // clients that support streaming will have each
        // forecast streamed to them as they complete
        if (request.acceptsStreaming) {
          response.sendChunk(result);
        }

        return result;
      },
  );

  // Return the full set of data to all clients
  return Promise.all(allRequests);
});
index.js

שימו לב: אופן הפעולה של response.sendChunk() תלוי בפרטים מסוימים של הבקשה של הלקוח:

1. אם הלקוח מבקש תשובה בסטרימינג: response.sendChunk(data) שולח את חלק הנתונים באופן מיידי.

2. אם הלקוח לא מבקש תגובה בסטרימינג: response.sendChunk() לא מתבצעת פעולה לגבי השיחה הזו. התשובה המלאה נשלחת כשכל הנתונים מוכנים.

כדי לבדוק אם הלקוח מבקש תשובה שמוצגת באופן שוטף, בודקים את המאפיין request.acceptsStreaming. לדוגמה, אם הערך של request.acceptsStreaming הוא false, יכול להיות שתחליטו לדלג על עבודה שדורשת הרבה משאבים שקשורה באופן ספציפי להכנה או לשליחה של נתחים נפרדים, כי הלקוח לא מצפה למסירה מצטברת.

קבלת תוצאות של שידור

בתרחיש טיפוסי, הלקוח מבקש סטרימינג באמצעות השיטה .stream ואז חוזר על התהליך עם התוצאות:

Swift

func listenToWeatherForecast() async throws {
    isLoading = true
    defer { isLoading = false }

    Functions
      .functions(region: "us-central1")
    let getForecast: Callable<WeatherRequest, StreamResponse<WeatherResponse, [WeatherResponse]>> = Functions.functions().httpsCallable("getForecast")

    let request = WeatherRequest(locations: locations)
    let stream = try getForecast.stream(request)

    for try await response in stream {
      switch response {
      case .message(let singleResponse):
        weatherData["\(singleResponse.latitude),\(singleResponse.longitude)"] = singleResponse
      case .result(let arrayOfResponses):
        for response in arrayOfResponses {
          weatherData["\(response.latitude),\(response.longitude)"] = response
        }
        print("Stream ended.")
        return
      }
    }
  }

Web

// Get the callable by passing an initialized functions SDK.
const getForecast = httpsCallable(functions, "getForecast");

// Call the function with the `.stream()` method to start streaming.
const { stream, data } = await getForecast.stream({
  locations: favoriteLocations,
});

// The `stream` async iterable returned by `.stream()`
// will yield a new value every time the callable
// function calls `sendChunk()`.
for await (const forecastDataChunk of stream) {
  // update the UI every time a new chunk is received
  // from the callable function
  updateUi(forecastDataChunk);
}

// The `data` promise resolves when the callable
// function completes.
const allWeatherForecasts = await data;
finalizeUi(allWeatherForecasts);
index.html

מבצעים לולאה על stream async iterable כמו שמוצג. ההמתנה ל-data promise מציינת ללקוח שהבקשה הושלמה

Kotlin

// Get the callable by passing an initialized functions SDK.
val getForecast = functions.getHttpsCallable("getForecast");

// Call the function with the `.stream()` method and convert it to a flow
getForecast.stream(
  mapOf("locations" to favoriteLocations)
).asFlow().collect { response ->
  when (response) {
    is StreamResponse.Message -> {
      // The flow will emit a [StreamResponse.Message] value every time the
      // callable function calls `sendChunk()`.
      val forecastDataChunk = response.message.data as Map<String, Any>
      // Update the UI every time a new chunk is received
      // from the callable function
      updateUI(
        forecastDataChunk["latitude"] as Double,
        forecastDataChunk["longitude"] as Double,
        forecastDataChunk["forecast"] as Double,
      )
    }
    is StreamResponse.Result -> {
      // The flow will emit a [StreamResponse.Result] value when the
      // callable function completes.
      val allWeatherForecasts = response.result.data as List<Map<String, Any>>
      finalizeUI(allWeatherForecasts)
    }
  }
}
MainActivity.kt

כדי להשתמש בפונקציית התוסף asFlow(), צריך להוסיף את הספרייה org.jetbrains.kotlinx:kotlinx-coroutines-reactive כתלות לקובץ build.gradle(.kts) של האפליקציה.

Java

// Get the callable by passing an initialized functions SDK.
HttpsCallableReference getForecast = mFunctions.getHttpsCallable("getForecast");
getForecast.stream(
  new HashMap<String, Object>() {{
    put("locations", favoriteLocations);
  }}
).subscribe(new Subscriber<StreamResponse>() {
  @Override
  public void onSubscribe(Subscription subscription) {
    subscription.request(Long.MAX_VALUE);
  }

  @Override
  public void onNext(StreamResponse streamResponse) {
    if (streamResponse instanceof StreamResponse.Message) {
      // The flow will emit a [StreamResponse.Message] value every time the
      // callable function calls `sendChunk()`.
      StreamResponse.Message response = (StreamResponse.Message) streamResponse;
      Map<String, Object> forecastDataChunk =
        (Map<String, Object>) response.getMessage().getData();
      // Update the UI every time a new chunk is received
      // from the callable function
      updateUI(
        (double) forecastDataChunk.get("latitude"),
        (double) forecastDataChunk.get("longitude"),
        (double) forecastDataChunk.get("forecast")
      );
    } else if(streamResponse instanceof StreamResponse.Result) {
      // The flow will emit a [StreamResponse.Result] value when the
      // callable function completes.
      StreamResponse.Result response = (StreamResponse.Result) streamResponse;
      List<Map<String, Object>> allWeatherForecasts =
        (List<Map<String, Object>>) response.getResult().getData();
      finalizeUI();
    }
  }

  @Override
  public void onError(Throwable throwable) {
    // an error occurred in the function
  }

  @Override
  public void onComplete() {

  }
});
MainActivity.java

הגדרת CORS (שיתוף משאבים בין מקורות)

אפשר להשתמש באפשרות cors כדי לקבוע לאילו מקורות תהיה גישה לפונקציה.

כברירת מחדל, לפונקציות שאפשר להפעיל יש הגדרות CORS שמאפשרות בקשות מכל המקורות. כדי לאפשר חלק מהבקשות חוצות המקור, אבל לא את כולן, צריך להעביר רשימה של דומיינים ספציפיים או ביטויים רגולריים שצריך לאפשר. לדוגמה:

Node.js

const { onCall } = require("firebase-functions/v2/https");

exports.getGreeting = onCall(
  { cors: [/firebase\.com$/, "https://flutter.com"] },
  (request) => {
    return "Hello, world!";
  }
);

כדי לאסור בקשות חוצות מקורות, מגדירים את המדיניות cors לערך false.

טיפול בשגיאות

כדי לוודא שהלקוח יקבל פרטי שגיאה שימושיים, צריך להחזיר שגיאות משיטה שאפשר להפעיל על ידי הפעלת חריגה (או ב-Node.js על ידי החזרת Promise שנדחה עם) מופע של functions.https.HttpsError או https_fn.HttpsError. לשגיאה יש מאפיין code שיכול להיות אחד מהערכים שמפורטים בקודי הסטטוס של gRPC. השגיאות כוללות גם מחרוזת message, שערך ברירת המחדל שלה הוא מחרוזת ריקה. יכול להיות שיהיה להם גם שדה details אופציונלי עם ערך שרירותי. אם הפונקציות שלכם מחזירות שגיאה אחרת ולא שגיאת HTTPS, הלקוח מקבל שגיאה עם ההודעה INTERNAL והקוד internal.

לדוגמה, פונקציה יכולה להחזיר שגיאות של אימות נתונים ואימות עם הודעות שגיאה ללקוח שקורא לפונקציה:

Node.js

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

Python

# Checking attribute.
if not isinstance(text, str) or len(text) < 1:
    # Throwing an HttpsError so that the client gets the error details.
    raise https_fn.HttpsError(code=https_fn.FunctionsErrorCode.INVALID_ARGUMENT,
                              message=('The function must be called with one argument, "text",'
                                       " containing the message text to add."))

# Checking that the user is authenticated.
if req.auth is None:
    # Throwing an HttpsError so that the client gets the error details.
    raise https_fn.HttpsError(code=https_fn.FunctionsErrorCode.FAILED_PRECONDITION,
                              message="The function must be called while authenticated.")
main.py

פריסת הפונקציה שאפשר לקרוא לה

אחרי ששומרים פונקציה שאפשר להפעיל ב-index.js, היא נפרסת יחד עם כל הפונקציות האחרות כשמריצים את firebase deploy. כדי לפרוס רק את הפונקציה שאפשר להפעיל, משתמשים בארגומנט --only כמו בדוגמה כדי לבצע פריסות חלקיות:

firebase deploy --only functions:addMessage

אם נתקלתם בשגיאות הרשאות כשפרסתם פונקציות, ודאו שתפקידי ה-IAM המתאימים הוקצו למשתמש שמריץ את פקודות הפריסה.

הגדרת סביבת הפיתוח של הלקוח

מוודאים שאתם עומדים בדרישות המוקדמות, ואז מוסיפים לאפליקציה את התלות הנדרשת ואת ספריות הלקוח.

‫iOS+

פועלים לפי ההוראות להוספת Firebase לאפליקציית Apple.

משתמשים ב-Swift Package Manager כדי להתקין ולנהל יחסי תלות ב-Firebase.

במדריך ההתקנה מוסברות הדרכים השונות להוספת Firebase SDK לפרויקט Apple, כולל ייבוא של מסגרות ישירות ושימוש ב-CocoaPods.

1. ב-Xcode, כשהפרויקט של האפליקציה פתוח, עוברים אל File > Add Packages (קובץ > הוספת חבילות).
2. כשמוצגת בקשה, מוסיפים את מאגר Firebase Apple platforms SDK:

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

הערה: בפרויקטים חדשים צריך להשתמש בגרסת ה-SDK שמוגדרת כברירת מחדל (הגרסה העדכנית ביותר), אבל אפשר לבחור גרסה ישנה יותר אם צריך.
3. בוחרים את הספרייה Cloud Functions.
4. מוסיפים את הדגל -ObjC לקטע Other Linker Flags בהגדרות הבנייה של היעד.
5. אחרי שתסיימו, פלטפורמת Xcode תתחיל באופן אוטומטי לטפל ביחסי התלות ולהוריד אותם ברקע.

Web

1. פועלים לפי ההוראות כדי להוסיף את Firebase לאפליקציית האינטרנט. חשוב להריץ את הפקודה הבאה מהטרמינל:

   npm install firebase@11.10.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);

Android

1. פועלים לפי ההוראות להוספת Firebase לאפליקציית Android.

2. בקובץ Gradle של המודול (ברמת האפליקציה) (בדרך כלל <project>/<app-module>/build.gradle.kts או <project>/<app-module>/build.gradle), מוסיפים את התלות בספריית Cloud Functions ל-Android. מומלץ להשתמש ב-Firebase Android BoM כדי לשלוט בניהול הגרסאות של הספריות.

   dependencies {
       // Import the BoM for the Firebase platform
       implementation(platform("com.google.firebase:firebase-bom:33.16.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.

   (חלופה)  מוסיפים תלות בספריית Firebase בלי להשתמש ב-BoM

   אם לא משתמשים ב-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 יכולים להסתמך על מודול הספרייה הראשי (פרטים נוספים זמינים במאמר שאלות נפוצות בנושא).

אתחול ה-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

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

הערה: כדי להפעיל פונקציה שפועלת במיקום כלשהו שאינו מיקום ברירת המחדל 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 כדי לוודא שרק האפליקציות שלכם יוכלו לגשת לנקודות הקצה של הפונקציות שאפשר להפעיל.