راه‌اندازی چابک

مراحل راه‌اندازی چابک

برای راه‌اندازی چابک باید دو مرحله زیر را به ترتیب انجام دهید تا بتوانید دستگاه خود را در پنل چابک مشاهده کنید :

  1. مقدار‌‌‌‌‌دهی اولیه
  2. ثبت کاربر

نکته :‌ تمامی متدهایی که در این بخش بیان می‌شود باید تنها یک بار فراخوانی شود.

۱- مقدار‌دهی اولیه

برای ارتباط با سرور چابک، لازم است یک نمونه از کلاس chabokpush بسازید و آن را مقدار‌دهی کنید. برای مقدار‌دهی اولیه می‌بایست از طریق متد chabok اطلاعات حساب چابک و تنظیمات اولیه را وارد نمایید. ایجاد حساب در بخش پیش‌نیازها توضیح داده شده است. در صورت داشتن حساب چابک هم می‌توانید این مقادیر را از پنل بخش تنظیمات قسمت دسترسی‌ و توکن‌ها بردارید.

برای دریافت یا ارسال پیام از/به سرور چابک، لازم است یک نمونه از کلاس chabokpush بسازید و آن را مقدار‌دهی نمایید. فراخوانی این متد فقط یکبار کافی‌ است. به قطعه کد زیر دقت کنید :

const auth = {
  appId: 'APP_ID',
  apiKey: 'API_KEY(SDK_KEY)',
  username: 'USERNAME',
  password: 'PASSWORD',
  devMode:true
}
const options = {
      webpush: {
        enabled: true,
        publicKey: 'VAPID_Public_Key'
      },
      silent: false,
    };
const chabok = new chabokpush.Chabok(auth, options)

نکته : به طور کلی چابک شامل ۲ محیط سندباکس و عملیاتی می‌باشد. حساب‌های رایگان چابک (تا ۳۰ هزار کاربر) بر روی محیط سندباکس و حساب‌های پریمیوم روی عملیاتی قرار می‌گیرند. مقدار true برای ‌devMode باعث اتصال به محیط سندباکس و مقدار false باعث اتصال به محیط عملیاتی ما می‌شود.

تنظیمات اولیه
توضیحات پیش‌فرض نوع پارامتر
    Object [options]
فعال/غیرفعال‌سازی ارتباط آنی true Boolean [options.realtime]
    Object [options.webpush]
فعال‌سازی پوش ‌نوتیفیکیشن false Object [options.webpush.enabled]
پوش‌نوتیفیکیشن Public Key null String [options.webpush.publicKey]
دریافت مخفی پیام true Boolean [options.silent]

نکته : برای استفاده از چابک در محیط عملیاتی مقدار devMode را false کنید. دقت داشته باشید که اگر محیط چابک را تغییر می‌دهید، حتما باید اطلاعات حساب چابک (AppId ،Username ،APIKey و Password) را هم تغییر دهید.

نکته : در صورتی که مقدار‌دهی اولیه به درستی اعمال شده باشد، می‌توانید اطلاعات دستگاه متصل خود را در بخش مشترکین پنل چابک مشاهده کنید.

۲- ثبت کاربر

با استفاده از متد register می‌توانید یک نام کاربری به هر کاربر اختصاص دهید. این متد شناسه کاربر را گرفته و کاربر را با آن شناسه روی سرور چابک ثبت نام می‌کند.

    chabok.register('<USER_ID>')

نکته : متد register باید فقط یک بار در طول اجرا اپلیکیشن فراخوانی شود.

نکته امنیتی : مقدار USER_ID را هرگز به صورت خام در LocalStorage ذخیره نکنید، چون این مقدار شناسه معنادار می‌باشد و می‌توان با آن کاربر را روی چابک ثبت‌نام کرد. برای این منظور می‌توانید از متد ()chabok.getUserId چابک استفاده کنید که شناسه کاربر را به صورت رمزنگاری شده نگه‌ می‌دارد.

if (chabok.isRegistered()) {
    chabok.register(chabok.getUserId())
} else {
    chabok.register('<USER_ID>')
}

نکته : متغیر USER_ID شناسه کاربر برای ثبت نام در چابک می‌باشد و ارسال پیام‌ به کاربران توسط همین شناسه‌ها و بدون استفاده از توکن یا شناسه گوشی، به سادگی امکان پذیر خواهد بود شناسه کاربری می تواند هر فیلد با ارزش و معنا‌دار برای کسب و کار شما باشد که کاربر خود را با آن شناسایی می‌کنید. شماره موبایل، کدملی، شماره حساب و یا ایمیل مثال‌هایی از شناسه‌های کاربری مناسب در موارد واقعی هستند.

نکته: کاراکترهای ‍#,+,*,\,/ و فاصله در USER_ID مجاز نیستند، همچنین طول این رشته نباید کمتر از ۳ و بیشتر از ۳۲ کاراکتر باشد.

متد حذف کاربر

برای حذف دستگاه کاربر از سرور چابک می‌توانید از متد زیر استفاده کنید :

chabok.unregister()

رویداد‌ها :

connecting: رویداد در هنگام برقراری اتصال به چابک

chabok.on('connecting', _ => {status = 'Connecting ...'}); 

connected: رویداد در حالت برقراری اتصال به چابک

chabok.on('connected', _ => {status = 'connected ...'}); 

disconnected: رویداد در حالت قطع اتصال چابک

chabok.on('disconnected', _ => {status = 'disconnected ...'}); 

نحوه صحیح پیاده سازی متد و رویدادها در قالب پروژه دمو پیاده سازی شده است.