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

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

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

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

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

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

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

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

const auth = {
  appId: 'APP_ID',
  apiKey: 'API_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)
تنظیمات اولیه
توضیحات پیش‌فرض نوع پارامتر
    Object [options]
فعال/غیرفعال سازی ارتباط آنی True Object [options.realtime]
    Object [options.webpush]
فعال‌سازی پوش ‌نوتیفیکیشن False Object [options.webpush.enabled]
پوش‌نوتیفیکیشن Public Key null String [options.webpush.publicKey]
دریافت مخفی پیام True Boolean [options.silent]

نکته : برای استفاده از چابک در محیط عملیاتی مقدار devMode را False کنید.

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

۲- ثبت کاربر

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

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

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

chabok.register('012345678910111213')

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

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

متد حذف کاربر

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

chabok.unregister()

رویداد ها:

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

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

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

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

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

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

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