firebase-admin.app package

ফায়ারবেস অ্যাপ এবং SDK শুরু।

ফাংশন

ফাংশন বর্ণনা
অ্যাপ্লিকেশন ডিফল্ট(httpAgent) Google অ্যাপ্লিকেশান ডিফল্ট শংসাপত্র থেকে তৈরি একটি শংসাপত্র ফেরত দেয় যা ফায়ারবেস পরিষেবাগুলিতে অ্যাডমিন অ্যাক্সেস দেয়৷ এই শংসাপত্রটি ইনিশিয়ালাইজ অ্যাপ() কলে ব্যবহার করা যেতে পারে . Google অ্যাপ্লিকেশন ডিফল্ট শংসাপত্রগুলি Google অ্যাপ ইঞ্জিন এবং Google কম্পিউট ইঞ্জিনের মতো যেকোনো Google পরিকাঠামোতে উপলব্ধ। আরো বিস্তারিত জানার জন্য SDK শুরু করুন দেখুন।
শংসাপত্র (serviceAccountPathOrObject, httpAgent) প্রদত্ত পরিষেবা অ্যাকাউন্ট থেকে তৈরি একটি শংসাপত্র ফেরত দেয় যা ফায়ারবেস পরিষেবাগুলিতে প্রশাসককে অ্যাক্সেস দেয়৷ এই শংসাপত্রটি ইনিশিয়ালাইজ অ্যাপ() কলে ব্যবহার করা যেতে পারে . আরো বিস্তারিত জানার জন্য SDK শুরু করুন দেখুন।
ডিলিটঅ্যাপ(অ্যাপ) এই প্রদত্ত App অব্যবহারযোগ্য করে তোলে এবং সমস্ত সম্পর্কিত পরিষেবার সংস্থানগুলিকে মুক্ত করে (যদিও এটি কোনও ব্যাকএন্ড সংস্থান * পরিষ্কার করে না)। স্থানীয়ভাবে SDK চালানোর সময়, প্রক্রিয়াটির সুন্দর সমাপ্তি নিশ্চিত করতে এই পদ্ধতিটি অবশ্যই কল করতে হবে।
getApp(অ্যাপনাম)
getApps()
ইনিশিয়ালাইজ অ্যাপ (বিকল্প, অ্যাপ নাম)
refreshToken(refreshTokenPathOrObject, httpAgent) প্রদত্ত রিফ্রেশ টোকেন থেকে তৈরি একটি শংসাপত্র ফেরত দেয় যা ফায়ারবেস পরিষেবাগুলিতে অ্যাডমিনকে অ্যাক্সেস দেয়৷ এই শংসাপত্রটি ইনিশিয়ালাইজ অ্যাপ() কলে ব্যবহার করা যেতে পারে . আরো বিস্তারিত জানার জন্য SDK শুরু করুন দেখুন।

ইন্টারফেস

ইন্টারফেস বর্ণনা
অ্যাপ একটি Firebase অ্যাপ পরিষেবার সংগ্রহের জন্য প্রাথমিক তথ্য ধারণ করে।
অ্যাপ অপশন ইনিশিয়ালাইজ অ্যাপ() এ পাস করার জন্য উপলব্ধ বিকল্পগুলি .
শংসাপত্র ইন্টারফেস যা Google OAuth2 অ্যাক্সেস টোকেন সরবরাহ করে Firebase পরিষেবাগুলির সাথে প্রমাণীকরণের জন্য ব্যবহৃত হয়৷ বেশীরভাগ ক্ষেত্রে, আপনাকে নিজে এটি বাস্তবায়ন করতে হবে না এবং পরিবর্তে firebase-admin/app মডিউল দ্বারা প্রদত্ত ডিফল্ট বাস্তবায়ন ব্যবহার করতে পারেন।
FirebaseArrayIndexError কম্পোজিট টাইপ যাতে একটি FirebaseError অবজেক্ট এবং একটি সূচক উভয়ই অন্তর্ভুক্ত থাকে যা ত্রুটিযুক্ত আইটেম পেতে ব্যবহার করা যেতে পারে।
FirebaseError FirebaseError হল স্ট্যান্ডার্ড JavaScript Error অবজেক্টের একটি সাবক্লাস। একটি বার্তা স্ট্রিং এবং স্ট্যাক ট্রেস ছাড়াও, এটিতে একটি স্ট্রিং কোড রয়েছে।
GoogleOAuthAccessToken Google OAuth 2.0 অ্যাক্সেস টোকেনের জন্য ইন্টারফেস।
সার্ভিস অ্যাকাউন্ট

ভেরিয়েবল

পরিবর্তনশীল বর্ণনা
SDK_VERSION

অ্যাপ্লিকেশন ডিফল্ট()

Google অ্যাপ্লিকেশান ডিফল্ট শংসাপত্র থেকে তৈরি একটি শংসাপত্র ফেরত দেয় যা ফায়ারবেস পরিষেবাগুলিতে অ্যাডমিন অ্যাক্সেস দেয়৷ এই শংসাপত্রটি ইনিশিয়ালাইজ অ্যাপ() কলে ব্যবহার করা যেতে পারে .

Google অ্যাপ্লিকেশন ডিফল্ট শংসাপত্রগুলি Google অ্যাপ ইঞ্জিন এবং Google কম্পিউট ইঞ্জিনের মতো যেকোনো Google পরিকাঠামোতে উপলব্ধ।

আরো বিস্তারিত জানার জন্য SDK শুরু করুন দেখুন।

স্বাক্ষর:

export declare function applicationDefault(httpAgent?: Agent): Credential;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
httpAgent প্রতিনিধি Google টোকেন সার্ভার থেকে অ্যাক্সেস টোকেন পুনরুদ্ধার করার সময় ঐচ্ছিক HTTP এজেন্ট ব্যবহার করা হবে।

রিটার্ন:

শংসাপত্র

Google অ্যাপ্লিকেশন ডিফল্ট শংসাপত্রের মাধ্যমে প্রমাণীকৃত একটি শংসাপত্র যা একটি অ্যাপ শুরু করতে ব্যবহার করা যেতে পারে।

উদাহরণ

initializeApp({
  credential: applicationDefault(),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

শংসাপত্র()

প্রদত্ত পরিষেবা অ্যাকাউন্ট থেকে তৈরি একটি শংসাপত্র ফেরত দেয় যা ফায়ারবেস পরিষেবাগুলিতে প্রশাসককে অ্যাক্সেস দেয়৷ এই শংসাপত্রটি ইনিশিয়ালাইজ অ্যাপ() কলে ব্যবহার করা যেতে পারে .

আরো বিস্তারিত জানার জন্য SDK শুরু করুন দেখুন।

স্বাক্ষর:

export declare function cert(serviceAccountPathOrObject: string | ServiceAccount, httpAgent?: Agent): Credential;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
serviceAccountPathOrObject স্ট্রিং | সার্ভিস অ্যাকাউন্ট একটি পরিষেবা অ্যাকাউন্ট কী JSON ফাইল বা পরিষেবা অ্যাকাউন্ট কী প্রতিনিধিত্বকারী একটি বস্তুর পথ৷
httpAgent প্রতিনিধি Google টোকেন সার্ভার থেকে অ্যাক্সেস টোকেন পুনরুদ্ধার করার সময় ঐচ্ছিক HTTP এজেন্ট ব্যবহার করা হবে।

রিটার্ন:

শংসাপত্র

প্রদত্ত পরিষেবা অ্যাকাউন্টের মাধ্যমে প্রমাণিত একটি শংসাপত্র যা একটি অ্যাপ শুরু করতে ব্যবহার করা যেতে পারে।

উদাহরণ 1

// Providing a path to a service account key JSON file
const serviceAccount = require("path/to/serviceAccountKey.json");
initializeApp({
  credential: cert(serviceAccount),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

উদাহরণ 2

// Providing a service account object inline
initializeApp({
  credential: cert({
    projectId: "<PROJECT_ID>",
    clientEmail: "foo@<PROJECT_ID>.iam.gserviceaccount.com",
    privateKey: "-----BEGIN PRIVATE KEY-----<KEY>-----END PRIVATE KEY-----\n"
  }),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

ডিলিট অ্যাপ()

এই প্রদত্ত App অব্যবহারযোগ্য করে তোলে এবং সমস্ত সম্পর্কিত পরিষেবার সংস্থানগুলিকে মুক্ত করে (যদিও এটি কোনও ব্যাকএন্ড সংস্থান * পরিষ্কার করে না)। স্থানীয়ভাবে SDK চালানোর সময়, প্রক্রিয়াটির সুন্দর সমাপ্তি নিশ্চিত করতে এই পদ্ধতিটি অবশ্যই কল করতে হবে।

স্বাক্ষর:

export declare function deleteApp(app: App): Promise<void>;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
অ্যাপ অ্যাপ

রিটার্ন:

প্রতিশ্রুতি <void>

উদাহরণ

deleteApp(app)
  .then(function() {
    console.log("App deleted successfully");
  })
  .catch(function(error) {
    console.log("Error deleting app:", error);
  });

অ্যাপ টি নিন()

স্বাক্ষর:

export declare function getApp(appName?: string): App;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
অ্যাপ্লিকেশন নাম স্ট্রিং

রিটার্ন:

অ্যাপ

getApps()

স্বাক্ষর:

export declare function getApps(): App[];

রিটার্ন:

অ্যাপ []

ইনিশিয়ালাইজ অ্যাপ()

স্বাক্ষর:

export declare function initializeApp(options?: AppOptions, appName?: string): App;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
বিকল্প অ্যাপ অপশন
অ্যাপ্লিকেশন নাম স্ট্রিং

রিটার্ন:

অ্যাপ

refreshToken()

প্রদত্ত রিফ্রেশ টোকেন থেকে তৈরি একটি শংসাপত্র ফেরত দেয় যা ফায়ারবেস পরিষেবাগুলিতে অ্যাডমিনকে অ্যাক্সেস দেয়৷ এই শংসাপত্রটি ইনিশিয়ালাইজ অ্যাপ() কলে ব্যবহার করা যেতে পারে .

আরো বিস্তারিত জানার জন্য SDK শুরু করুন দেখুন।

স্বাক্ষর:

export declare function refreshToken(refreshTokenPathOrObject: string | object, httpAgent?: Agent): Credential;

পরামিতি

প্যারামিটার টাইপ বর্ণনা
RefreshTokenPathOrObject স্ট্রিং | বস্তু একটি Google OAuth2 রিফ্রেশ টোকেন JSON ফাইল বা Google OAuth2 রিফ্রেশ টোকেন প্রতিনিধিত্বকারী একটি বস্তুর পথ।
httpAgent প্রতিনিধি Google টোকেন সার্ভার থেকে অ্যাক্সেস টোকেন পুনরুদ্ধার করার সময় ঐচ্ছিক HTTP এজেন্ট ব্যবহার করা হবে।

রিটার্ন:

শংসাপত্র

প্রদত্ত পরিষেবা অ্যাকাউন্টের মাধ্যমে প্রমাণিত একটি শংসাপত্র যা একটি অ্যাপ শুরু করতে ব্যবহার করা যেতে পারে।

উদাহরণ

// Providing a path to a refresh token JSON file
const refreshToken = require("path/to/refreshToken.json");
initializeApp({
  credential: refreshToken(refreshToken),
  databaseURL: "https://<DATABASE_NAME>.firebaseio.com"
});

SDK_VERSION

স্বাক্ষর:

SDK_VERSION: string