ব্রাউজার.রানটাইম

বর্ণনা

এই API-এর বেশিরভাগ সদস্যের কোনো অনুমতির প্রয়োজন হয় না । connectNative() , sendNativeMessage() এবং onNativeConnect জন্য এই অনুমতিটি প্রয়োজন।

নিম্নলিখিত উদাহরণটি দেখায় কিভাবে ম্যানিফেস্টে "nativeMessaging" পারমিশনটি ঘোষণা করতে হয়:

manifest.json:

{
  "name": "My extension",
  ...
  "permissions": [
    "nativeMessaging"
  ],
  ...
}

ধারণা এবং ব্যবহার

রানটাইম এপিআই এমন অনেক ক্ষেত্রকে সমর্থন করার জন্য পদ্ধতি সরবরাহ করে যা আপনার এক্সটেনশনগুলো ব্যবহার করতে পারে:

বার্তা প্রেরণ

আপনার এক্সটেনশনটি connect() , onConnect , onConnectExternal , sendMessage() , onMessage এবং onMessageExternal এই মেথড ও ইভেন্টগুলো ব্যবহার করে নিজের ভেতরের বিভিন্ন কনটেক্সটের সাথে এবং অন্যান্য এক্সটেনশনের সাথেও যোগাযোগ করতে পারে। এছাড়াও, আপনার এক্সটেনশনটি connectNative() এবং sendNativeMessage() ব্যবহার করে ব্যবহারকারীর ডিভাইসের নেটিভ অ্যাপ্লিকেশনগুলোতে মেসেজ পাঠাতে পারে।

এক্সটেনশন এবং প্ল্যাটফর্ম মেটাডেটা অ্যাক্সেস করা

এই পদ্ধতিগুলো আপনাকে এক্সটেনশন এবং প্ল্যাটফর্ম সম্পর্কে বেশ কিছু নির্দিষ্ট মেটাডেটা পুনরুদ্ধার করতে দেয়। এই বিভাগের পদ্ধতিগুলোর মধ্যে রয়েছে getManifest() এবং getPlatformInfo() ।

এক্সটেনশন জীবনচক্র এবং বিকল্পগুলি পরিচালনা করা

এই প্রোপার্টিগুলো আপনাকে এক্সটেনশনের উপর কিছু মেটা-অপারেশন করতে এবং অপশন পেজ প্রদর্শন করতে দেয়। এই ক্যাটাগরির মেথড এবং ইভেন্টগুলোর মধ্যে রয়েছে onInstalled , onStartup , openOptionsPage() , reload() , requestUpdateCheck() , এবং setUninstallURL() ।

সহায়ক ইউটিলিটি

এই মেথডগুলো অভ্যন্তরীণ রিসোর্স রিপ্রেজেন্টেশনকে বাহ্যিক ফরম্যাটে রূপান্তরের মতো সুবিধা প্রদান করে। এই ক্যাটাগরির মেথডগুলোর মধ্যে getURL() অন্তর্ভুক্ত।

কিয়স্ক মোড ইউটিলিটিগুলি

এই মেথডগুলো শুধুমাত্র ChromeOS-এ উপলব্ধ, এবং এগুলো মূলত কিয়স্ক ইমপ্লিমেন্টেশনকে সমর্থন করার জন্য বিদ্যমান। এই ক্যাটাগরির মেথডগুলোর মধ্যে restart() এবং restartAfterDelay() ` অন্তর্ভুক্ত।

আনপ্যাক করা এক্সটেনশন আচরণ

যখন কোনো আনপ্যাক করা এক্সটেনশন রিলোড করা হয়, তখন এটিকে একটি আপডেট হিসেবে গণ্য করা হয়। এর মানে হলো, browser.runtime.onInstalled ইভেন্টটি "update" কারণসহ ফায়ার হবে। browser.runtime.reload() দিয়ে এক্সটেনশনটি রিলোড করা হলেও এটি প্রযোজ্য।

ব্যবহারের ক্ষেত্র

একটি ওয়েব পৃষ্ঠায় একটি ছবি যোগ করুন

একটি ওয়েব পেজ থেকে অন্য ডোমেইনে হোস্ট করা কোনো অ্যাসেট অ্যাক্সেস করতে হলে, সেটিকে অবশ্যই রিসোর্সটির সম্পূর্ণ URL উল্লেখ করতে হবে (যেমন <img src="https://example.com/logo.png"> )। একটি ওয়েব পেজে এক্সটেনশন অ্যাসেট অন্তর্ভুক্ত করার ক্ষেত্রেও একই নিয়ম প্রযোজ্য। দুটি পার্থক্য হলো, এক্সটেনশনের অ্যাসেটগুলোকে অবশ্যই ওয়েব অ্যাক্সেসযোগ্য রিসোর্স হিসেবে প্রকাশ করতে হবে এবং সাধারণত কন্টেন্ট স্ক্রিপ্টগুলোই এক্সটেনশন অ্যাসেটগুলো ইনজেক্ট করার দায়িত্বে থাকে।

এই উদাহরণে, এক্সটেনশনটি runtime.getURL() ব্যবহার করে একটি সম্পূর্ণ-যোগ্য URL তৈরি করার মাধ্যমে, কন্টেন্ট স্ক্রিপ্ট ইনজেক্ট করা পেজটিতে logo.png যোগ করবে। কিন্তু তার আগে, অ্যাসেটটিকে ম্যানিফেস্টে একটি ওয়েব অ্যাক্সেসযোগ্য রিসোর্স হিসেবে ঘোষণা করতে হবে।

manifest.json:

{
  ...
  "web_accessible_resources": [
    {
      "resources": [ "logo.png" ],
      "matches": [ "https://*/*" ]
    }
  ],
  ...
}

content.js:

{ // Block used to avoid setting global variables
  const img = document.createElement('img');
  img.src = browser.runtime.getURL('logo.png');
  document.body.append(img);
}

কন্টেন্ট স্ক্রিপ্ট থেকে সার্ভিস ওয়ার্কারে ডেটা পাঠান

প্রায়শই একটি এক্সটেনশনের কন্টেন্ট স্ক্রিপ্টগুলোর এমন ডেটার প্রয়োজন হয় যা এক্সটেনশনটিরই অন্য কোনো অংশ, যেমন সার্ভিস ওয়ার্কার, দ্বারা পরিচালিত হয়। একই ওয়েব পেজে খোলা দুটি ব্রাউজার উইন্ডোর মতোই, এই দুটি কনটেক্সট সরাসরি একে অপরের ভ্যালু অ্যাক্সেস করতে পারে না। এর পরিবর্তে, এক্সটেনশনটি এই বিভিন্ন কনটেক্সটগুলোর মধ্যে সমন্বয় সাধনের জন্য মেসেজ পাসিং ব্যবহার করতে পারে।

এই উদাহরণে, কন্টেন্ট স্ক্রিপ্টটির UI ইনিশিয়ালাইজ করার জন্য এক্সটেনশনের সার্ভিস ওয়ার্কারের কাছ থেকে কিছু ডেটার প্রয়োজন হয়। এই ডেটা পাওয়ার জন্য, এটি ডেভেলপার-সংজ্ঞায়িত get-user-data মেসেজটি সার্ভিস ওয়ার্কারের কাছে পাঠায়, এবং সার্ভিস ওয়ার্কারটি ব্যবহারকারীর তথ্যের একটি কপি দিয়ে সাড়া দেয়।

content.js:

// 1. Send a message to the service worker requesting the user's data
browser.runtime.sendMessage('get-user-data', (response) => {
  // 3. Got an asynchronous response with the data from the service worker
  console.log('received user data', response);
  initializeUI(response);
});

service-worker.js:

// Example of a simple user data object
const user = {
  username: 'demo-user'
};

browser.runtime.onMessage.addListener((message, sender, sendResponse) => {
  // 2. A page requested user data, respond with a copy of `user`
  if (message === 'get-user-data') {
    sendResponse(user);
  }
});

আনইনস্টল করার বিষয়ে মতামত সংগ্রহ করুন

অনেক এক্সটেনশন তার ব্যবহারকারীদের আরও ভালোভাবে সেবা দেওয়ার এবং ধরে রাখার হার উন্নত করার উপায় বোঝার জন্য আনইনস্টল-পরবর্তী সমীক্ষা ব্যবহার করে। নিম্নলিখিত উদাহরণটি দেখায় কীভাবে এই কার্যকারিতাটি যুক্ত করতে হয়।

background.js:

browser.runtime.onInstalled.addListener(details => {
  if (details.reason === browser.runtime.OnInstalledReason.INSTALL) {
    browser.runtime.setUninstallURL('https://example.com/extension-survey');
  }
});

উদাহরণ

আরও রানটাইম এপিআই উদাহরণের জন্য ম্যানিফেস্ট ভি৩ - ওয়েব অ্যাক্সেসিবল রিসোর্সেস ডেমোটি দেখুন।