مستندات رایچت برای توسعه دهندگان سمت کاربر

API سمت کاربر این امکان را به شما می‌دهد تا ابزارکی که برای کاربر نمایش داده می‌شود را مدیریت کنید. از آن می‌توانید برای مدیریت صفحه چت و همچنین ارسال اطلاعات کاربر به اپلیکیشن رایچت استفاده کنید‌. (برای مثال می‌توانید اطلاعات کاربری که به سایت شما لاگین کرده را به رایچت بفرستید تا در اپلیکیشن نمایش داده بشه و بعداً در آرشیو بهش دسترسی داشته باشید).

نکته: تمامی توابع و رویداد‌هایی که در ادامه توضیح داده خواهند شد باید طبق دستورالعمل سمت راست (داخل رویداد raychat_ready) نوشته شوند.

1    window.addEventListener('raychat_ready', function (ets) {
2      // function or event 
3    });

با استفاده ازاین تابع میتوانید تغییراتی بر روی ظاهر آیکون ابزارک چت رایچت ایجاد کنید.

1    window.Raychat.setStyle({
2      backgroundColor : '#000',
3      borderRadius : '50%',
4      width : '70px',
5      height : '70px'
6    });

با استفاده ازاین تابع میتوانید موقعیت آیکون ابزارک چت را تغییر دهید. توجه داشته باشید که برای این که تغییر موقعیت ابزارک به درستی انجام شود حتما 4 موقعیت ذکر شده را ارسال کنید، به صورتی که حداکثر دو موقعیت مقدار داشته باشد و باقی فیلد ها مقدار "auto" داشته باشند.

1    window.Raychat.setPosition({
2      top: 'auto',
3      right : 'auto',
4      bottom : '15px',
5      left : '15px'
6    });

با استفاده از این تابع می توانید اطلاعات کاربری که به وب سایت شما لاگین کرده را به رایچت ارسال کنید.

1    window.Raychat.setUser({
2      email: 'tech@raychat.io',
3      name: 'Ehsan Younesi',
4      about: 'about me :)',
5      phone: '09123456789',
6      avatar: 'https://webapp.raychat.io/ehsan.png',
7      updateOnce: true
8    });

با این تابع میتوانید کاربرانی که در سیستم شما وارد پنل کاربری میشوند را بارگزاری کنید و مکالمات آنان را به صورت دائمی و پایدار نگه داری کنید; زمانی که کاربر با موفقیت بارگزاری شد رویداد raychat_new_user_loaded اجرا میشود.

نکته: برای به دست آوردن ای دی کاربر میتوانید از تابع getUser استفاده کنید

نکته: حتما توجه داشته باشید که با لود کردن کاربر جدید، اطلاعات کاربر فعلی (مکالمات و بقیه موارد) در صورتی که ای دی کاربر را در دیتابیسی ذخیره نداشته باشید برای همیشه غیرقابل دسترس خواهد بود.

1    window.Raychat.loadUser(userId);

باعث پاک شدن تمامی اطلاعات کاربر از مرورگر شده و در صورتی که کاربر دوباره اقدام به بازدید از سایت نمود به عنوان کاربر جدید شناخته میشود.

نکته: برای اعمال تغییرات، بعد از صدا زدن این تابع، مرورگر کاربر از نو بارگذاری شود.

نکته: در صورتی که ای دی کاربر را قبل از صدا زدن این تابع در دیتابیسی ذخیره نکنید، لود کردن دوباره این کاربر غیر ممکن خواهد بود.

1    window.Raychat.unloadUser();

ارسال پیام از طریق ابزارک رایچت به کاربر.

نکته: این پیام صرفا در سمت کاربر نمایش داده می‌شود و اپراتور قادر به دیدن این پیام نمی باشد و همچنین مکالمه محسوب نمی‌شود و با رفرش کردن صفحه پاک می‌شود.

1    window.Raychat.sendOfflineMessage('سلام وقت بخیر');

با استفاده از این تابع میتوانید ابزارک چت را باز کنید.

1    window.Raychat.open();

با استفاده از این تابع می توانید ابزارک چت را ببندید.

1    winow.Raychat.close();

در صورتی که ابزارک چت باز باشه هنگام فراخوانی این تابع، ابزارک بسته خواهد شد و یا بصورت بر عکس.

1    window.Raychat.toggle();

شخصی سازی حالت انیمیشن آیکون ابزارک چت. این کار باعث می‌شود که توجه کاربر بیشتر به ابزارک جلب شده و در نتیجه احتمال اینکه کاربر سر صحبت را باز کند بیشتر خواهد شد.

1    window.Raychat.animate('tada');

با استفاده از این تابع میتوان تشخیص داد که ابزار چک باز است یا خیر.

1    window.Raychat.isWidgetOpen();

زمانی که اطلاعات کاربر بروز می‌شود این رویداد اجرا می‌شود به طور مثال زمانی که کاربر ایمیلش را در قسمت با خبرشو ثبت می کند.

1    window.Raychat.on('raychat_user_profile_updated', function (user) {
2    });

زمانی که کاربر ابزارک چت را باز کند این رویداد اجرا می‌شود.

1    window.Raychat.on('open', function (s) {
2    });

زمانی که کاربر ابزارک چت را ببندد این رویداد اجرا می‌شود.

1    window.Raychat.on('close', function (s) {
2    });