Befrest Web SDK Documentation


افزودن کلاینت بفرست به پروژه

آخرین نسخه کلاینت بفرست را از اینجا دریافت کرده و آن را با استفاده از تکه کد زیر به صفحه وب مورد نظر خود اضافه کنید.

<script language="javascript" type="text/javascript" src="befrest.min.js"></script>
دسترسی به instance از بفرست

پس از افزودن فایل Javascript پیشتر ذکر شده، می‌توانید در هر صفحه وب با ارجاع مستقیم به تک نمونه کلاینت که befrest نام دارد به بفرست متصل شده و پیام‌های ارسال شده را دریافت کنید.

تنظیم اطلاعات اتصال

برای ست کردن سه پارامتر uid ،chid و auth از متد init استفاده کنید.

توابع کنترل روند اتصال به بفرست

تابع start باید حتما بعد از ست کردن اطلاعات اتصال صدا زده شود.
با صدا زدن تابع stop، تا زمانی که دوباره تابع start با صدا زدن تابع stop، تا زمانی که دوباره تابع start را صدا بزنید، پیام‌ها را دریافت نخواهید کرد. (با فعال کردن دوباره بفرست، همه پیام‌هایی که در مدت زمان توقف به کانال مورد نظر ارسال شده باشند را دریافت خواهید کرد.)

// Start receiving pushed messages
befrest.start();

// Stop receiving messages
befrest.stop();

شیوه‌ی معمول راه اندازی بفرست بصورت زیر است:

// Retrieve uid, chid and auth from your server
var uid;
var chid;
var auth;
var receiverCallback = function(msg) {};

befrest.init(uid, chid, auth, receiverCallback);
befrest.start();
دریافت پوش‌ها

برای دریافت پوش‌های ارسال شده کافیست از پارامتری از جنس callback به عنوان پارامتر چهارم متد befrest.init استفاده کنید.

var uid, chid, auth;
var receiverCallback = function(msg) {
    console.log(msg);
    alert(msg);
};

befrest.init(uid, chid, auth, receiverCallback);
befrest.start();

پس از دریافت هر یک از پوش‌ها، پیام دریافت شده با فراخوانی receiverCallback در اختیارتان قرار می‌گیرد.

تاپیک‌ها

با استفاده از متودهای زیر می‌توانید تاپیک‌هایی که تا کنون ثبت شده‌اند را بررسی کرده و تاپیک‌های مورد نظر را حذف و اضافه کنید.

befrest.addTopic('soccer');
befrest.addTopic('leicester');
befrest.removeTopic('manunited');
var subscribedTopics = befrest.getTopics();
befrest.start();

تاپیک‌های مورد نظر را باید قبل از start کردن بفرست اضافه کنید. چنانچه می‌خواهید پس از start کردن بفرست، تاپیک‌ها را کم یا اضافه کنید تابع start را پس از تغییر در تاپیک‌ها دوباره فراخوانی کنید.

افزایش امنیت در بفرست

برای بالا بردن امنیت در استفاده از بفرست، به جد توصیه می‌شود تا رشته auth در سرور تولید شده و در بارگذاری صفحه وب، پس از بارگذاری و با استفاده از یک درخواست ajax یا هر مکانیزم دیگری به سمت کلاینت ارسال شود.