ฟังก์ชั่นการโทรจากแอพของคุณ


Cloud Functions for Firebase client SDK ช่วยให้คุณเรียกใช้ฟังก์ชันต่างๆ ได้โดยตรงจากแอป Firebase หากต้องการเรียกใช้ฟังก์ชันจากแอปด้วยวิธีนี้ ให้เขียนและปรับใช้ฟังก์ชัน HTTP Callable ใน Cloud Functions จากนั้นเพิ่มตรรกะไคลเอ็นต์เพื่อเรียกใช้ฟังก์ชันจากแอปของคุณ

สิ่งสำคัญคือต้องจำไว้ว่าฟังก์ชันที่เรียกได้ของ HTTP นั้นคล้ายกันแต่ ไม่เหมือนกันกับ ฟังก์ชัน HTTP หากต้องการใช้ฟังก์ชันที่เรียกใช้ HTTP ได้ คุณต้องใช้ SDK ไคลเอ็นต์สำหรับแพลตฟอร์มของคุณร่วมกับ API แบ็กเอนด์ (หรือใช้โปรโตคอล) Callables มีความแตกต่างที่สำคัญจากฟังก์ชัน HTTP:

  • เมื่อใช้สิ่งที่เรียกได้ โทเค็นการตรวจสอบสิทธิ์ Firebase, โทเค็น FCM และโทเค็น App Check จะรวมอยู่ในคำขอโดยอัตโนมัติ
  • ทริกเกอร์จะดีซีเรียลไลซ์เนื้อหาคำขอโดยอัตโนมัติและตรวจสอบโทเค็นการตรวจสอบสิทธิ์

Firebase SDK สำหรับฟังก์ชันคลาวด์รุ่นที่ 2 และสูงกว่าทำงานร่วมกับ SDK ไคลเอ็นต์ Firebase เวอร์ชันขั้นต่ำเหล่านี้เพื่อรองรับฟังก์ชัน HTTPS Callable:

  • Firebase SDK สำหรับแพลตฟอร์ม Apple 10.19.0
  • Firebase SDK สำหรับ Android 20.4.0
  • Firebase Modular เว็บ SDK เวอร์ชัน 9.7.0

หากคุณต้องการเพิ่มฟังก์ชันการทำงานที่คล้ายกันให้กับแอปที่สร้างบนแพลตฟอร์มที่ไม่รองรับ โปรดดู ข้อกำหนดโปรโตคอลสำหรับ https.onCall ส่วนที่เหลือของคู่มือนี้จะให้คำแนะนำเกี่ยวกับวิธีการเขียน ปรับใช้ และเรียกใช้ฟังก์ชันที่เรียกใช้ HTTP สำหรับแพลตฟอร์ม Apple, Android, เว็บ, C++ และ Unity

เขียนและปรับใช้ฟังก์ชันที่เรียกได้

ใช้ functions.https.onCall เพื่อสร้างฟังก์ชันที่เรียกใช้ HTTPS ได้ วิธีการนี้ใช้พารามิเตอร์สองตัว: 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;

ระยะห่างระหว่างตำแหน่งของฟังก์ชันที่เรียกได้และตำแหน่งของไคลเอ็นต์ที่เรียกสามารถสร้างเวลาแฝงของเครือข่ายได้ เพื่อเพิ่มประสิทธิภาพ ให้พิจารณาระบุ ตำแหน่งฟังก์ชัน ตามความเหมาะสม และตรวจสอบให้แน่ใจว่าได้จัดตำแหน่งของผู้เรียกให้สอดคล้องกับตำแหน่งที่ตั้งค่าไว้เมื่อคุณ เริ่มต้น SDK บนฝั่งไคลเอ็นต์

คุณสามารถเลือกแนบเอกสารรับรอง App Check เพื่อช่วยปกป้องทรัพยากรแบ็กเอนด์จากการละเมิด เช่น การฉ้อโกงการเรียกเก็บเงินหรือฟิชชิง ดู เปิดใช้การบังคับใช้การตรวจสอบแอปสำหรับฟังก์ชันคลาวด์

ส่งผลกลับมา.

หากต้องการส่งข้อมูลกลับไปยังไคลเอ็นต์ ให้ส่งคืนข้อมูลที่เข้ารหัส 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 };
})

จัดการกับข้อผิดพลาด

เพื่อให้แน่ใจว่าไคลเอ็นต์ได้รับรายละเอียดข้อผิดพลาดที่เป็นประโยชน์ ให้ส่งคืนข้อผิดพลาดจากสิ่งที่เรียกได้โดยการโยน (หรือส่งคืน Promise ที่ถูกปฏิเสธด้วย) อินสแตนซ์ของ 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 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 แล้ว ฟังก์ชันดังกล่าวจะถูกปรับใช้พร้อมกับฟังก์ชันอื่นๆ ทั้งหมดเมื่อคุณเรียกใช้ firebase deploy หากต้องการปรับใช้เฉพาะ callable ให้ใช้อาร์กิวเมนต์ --only ตามที่แสดงเพื่อดำเนิน การปรับใช้บางส่วน :

firebase deploy --only functions:addMessage

หากคุณพบข้อผิดพลาดในการอนุญาตเมื่อปรับใช้ฟังก์ชัน ตรวจสอบให้แน่ใจว่าได้กำหนด บทบาท IAM ที่เหมาะสมให้กับผู้ใช้ที่รันคำสั่งการปรับใช้

ตั้งค่าสภาพแวดล้อมการพัฒนาไคลเอ็นต์ของคุณ

ตรวจสอบให้แน่ใจว่าคุณมีคุณสมบัติตรงตามข้อกำหนดเบื้องต้น จากนั้นเพิ่มการขึ้นต่อกันที่จำเป็นและไลบรารีไคลเอนต์ให้กับแอปของคุณ

ไอโอเอส+

ทำตามคำแนะนำเพื่อ เพิ่ม Firebase ลงในแอป Apple ของคุณ

ใช้ Swift Package Manager เพื่อติดตั้งและจัดการการพึ่งพา Firebase

  1. ใน Xcode เมื่อโปรเจ็กต์แอปของคุณเปิดอยู่ ให้ไปที่ File > Add Package
  2. เมื่อได้รับแจ้ง ให้เพิ่มพื้นที่เก็บข้อมูล SDK แพลตฟอร์ม Firebase Apple:
  3.   https://github.com/firebase/firebase-ios-sdk.git
  4. เลือกไลบรารี Cloud Functions
  5. เพิ่มแฟล็ก -ObjC ไปยังส่วน Other Linker Flags ของการตั้งค่า build ของเป้าหมายของคุณ
  6. เมื่อเสร็จแล้ว Xcode จะเริ่มแก้ไขและดาวน์โหลดการอ้างอิงของคุณโดยอัตโนมัติในเบื้องหลัง

API แบบโมดูลาร์ของเว็บ

  1. ทำตามคำแนะนำเพื่อ เพิ่ม Firebase ให้กับเว็บแอปของคุณ ตรวจสอบให้แน่ใจว่าได้รันคำสั่งต่อไปนี้จากเทอร์มินัลของคุณ:
    npm install firebase@10.7.1 --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);
    

API เนมสเปซของเว็บ

  1. ทำตามคำแนะนำเพื่อ เพิ่ม Firebase ให้กับเว็บแอปของคุณ
  2. เพิ่มไลบรารีไคลเอ็นต์ Firebase core และ 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+KTX

  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:32.7.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:20.4.0")
    }
    
    กำลังมองหาโมดูลไลบรารีเฉพาะของ Kotlin อยู่ใช่ไหม? เริ่มตั้งแต่ เดือนตุลาคม 2023 (Firebase BoM 32.5.0) ทั้งนักพัฒนา Kotlin และ Java สามารถพึ่งพาโมดูลไลบรารีหลักได้ (สำหรับรายละเอียด โปรดดู คำถามที่พบบ่อยเกี่ยวกับโครงการริเริ่มนี้ )

Java

  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:32.7.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:20.4.0")
    }
    
    กำลังมองหาโมดูลไลบรารีเฉพาะของ Kotlin อยู่ใช่ไหม? เริ่มตั้งแต่ เดือนตุลาคม 2023 (Firebase BoM 32.5.0) ทั้งนักพัฒนา Kotlin และ Java สามารถพึ่งพาโมดูลไลบรารีหลักได้ (สำหรับรายละเอียด โปรดดู คำถามที่พบบ่อยเกี่ยวกับโครงการริเริ่มนี้ )

Dart

  1. ทำตามคำแนะนำเพื่อ เพิ่ม Firebase ให้กับแอป Flutter ของคุณ

  2. จากรากของโปรเจ็กต์ Flutter ของคุณ ให้รันคำสั่งต่อไปนี้เพื่อติดตั้งปลั๊กอิน:

    flutter pub add cloud_functions
    
  3. เมื่อเสร็จแล้ว ให้สร้างแอปพลิเคชัน Flutter ของคุณใหม่:

    flutter run
    
  4. เมื่อติดตั้งแล้ว คุณสามารถเข้าถึงปลั๊กอิน cloud_functions โดยการนำเข้าลงในโค้ด Dart ของคุณ:

    import 'package:cloud_functions/cloud_functions.dart';
    

ซี++

สำหรับ C ++ พร้อม Android :

  1. ทำตามคำแนะนำเพื่อ เพิ่ม Firebase ให้กับโปรเจ็กต์ C++ ของคุณ
  2. เพิ่มไลบรารี firebase_functions ลงในไฟล์ CMakeLists.txt ของคุณ

สำหรับ C ++ พร้อมแพลตฟอร์ม Apple :

  1. ทำตามคำแนะนำเพื่อ เพิ่ม Firebase ให้กับโปรเจ็กต์ C++ ของคุณ
  2. เพิ่มพ็อด Cloud Functions ลงใน Podfile ของคุณ :
    pod 'Firebase/Functions'
  3. บันทึกไฟล์ จากนั้นรัน:
    pod install
  4. เพิ่มเฟรมเวิร์ก Firebase core และ Cloud Functions จาก Firebase C++ SDK ไปยังโปรเจ็กต์ Xcode ของคุณ
    • firebase.framework
    • firebase_functions.framework

ความสามัคคี

  1. ทำตามคำแนะนำเพื่อ เพิ่ม Firebase ให้กับโครงการ Unity ของคุณ
  2. เพิ่ม FirebaseFunctions.unitypackage จาก Firebase Unity SDK ไปยังโปรเจ็กต์ Unity ของคุณ

เตรียมใช้งาน SDK ไคลเอ็นต์

เริ่มต้นอินสแตนซ์ของฟังก์ชันคลาวด์:

สวิฟท์

lazy var functions = Functions.functions()

วัตถุประสงค์-C

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

API เนมสเปซของเว็บ

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

API แบบโมดูลาร์ของเว็บ

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

Kotlin+KTX

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

Java

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

Dart

final functions = FirebaseFunctions.instance;

ซี++

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

วัตถุประสงค์-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"];
}];

API เนมสเปซของเว็บ

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

API แบบโมดูลาร์ของเว็บ

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

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;

ซี++

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

วัตถุประสงค์-C

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

API เนมสเปซของเว็บ

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

API แบบโมดูลาร์ของเว็บ

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+KTX

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

ซี++

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

ก่อนที่คุณจะเปิดแอป คุณควรเปิดใช้งาน App Check เพื่อช่วยให้แน่ใจว่ามีเพียงแอปของคุณเท่านั้นที่สามารถเข้าถึงตำแหน่งข้อมูลฟังก์ชันที่เรียกใช้ได้