برو بریم!
document.addEventListener('hantana_ready', function () {
// function or event
});
API سمت کاربر این امکان را به شما می‌دهد تا ابزارکی را که برای کاربر نمایش داده می‌شود را مدیریت کنید. (برای مثال میتوانید اطلاعات کاربری مانند شماره موبایل و ایمیل که به سایت شما لاگین کرده را به هانتانا بفرستید تا از طریق پنل کاربری بتوانید از آن گزارش گیری کاملی داشته باشید).
نکته: تمامی توابع و رویداد‌هایی که در ادامه توضیح داده شده است باید طبق دستورالعمل سمت راست (داخل رویداد hantana_ready) نوشته شوند.
تابع setUserData
//set user
window.Hantana.setUserData({
name : "Mohammad",
email : "pm@hantana.org",
phone : "09123456789",
avatar: 'https://hantana.org/test.png',
description : "This is a test!",
});
این تابع به شما کمک میکند تا بتوانید اطلاعات کاربران خود را به هانتانا ارسال کرده و در صورت بازخورد کاربران به راحتی گزارش گیری خود را انجام دهید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| name | String | نام کاربر مورد نظر |
| String | ایمیل کاربر مورد نظر | |
| phone | String | شماره موبایل کاربر مورد نظر |
| avatar | String | عکس کاربر مورد نظر به صورت لینک |
| description | String | توضیحی کوتاه برای کاربر مورد نظر |
تابع openFeedback
//open feedback
window.Hantana.openFeedback(delayTime);
برای باز شدن ابزارک بازخورد میتوانید تابع زیر را فراخوانی کنید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | Number | زمان تاخیر |
تابع closeFeedback
//close feedback
window.Hantana.closeFeedback(delayTime);
برای بسته شدن ابزارک بازخورد میتوانید تابع زیر را فراخوانی کنید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | Number | زمان تاخیر |
تابع toggleFeedback
//toggle feedback
window.Hantana.toggleFeedback(delayTime);
این تابع به شما کمک میکند تا اگر ابزارک بازخورد روی صفحه باز شده است آن را بسته یا اگر بسته باشد آن را باز کنید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | Number | زمان تاخیر |
تابع setTitleFeedback
//set title text feedback
window.Hantana.setTitleFeedback(text);
با استفاده از تابع زیر میتوانید عنوان ابزارک بازخورد را تغییر دهید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| text | String | متن عنوان ابزارک بازخورد |
تابع setWelcomeMessageFeedback
//set wellcome message feedback
window.Hantana.setWelcomeMessageFeedback(delayTime, showTime, text);
با استفاده از این تابع میتوانید متن خوش آمد گویی برای ابزارک خود فعال کنید.
نکته: این تابع زمانی کار میکند که از پنل پیام خوش آمد گویی هوشمند را غیر فعال نمایید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | Number | مدت زمان انتظار تا متن خوش امد گویی نمایش داده شود |
| showTime | Number | مدت زمان نمایش متن خوش آمد گویی |
| text | String | متن خوش امد گویی |
تابع setDescriptionTextFeedback
//set description text feedback
window.Hantana.setDescriptionTextFeedback(text);
با استفاده از این تابع میتوانید متن توضیح برای ابزارک خود فعال کنید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| text | String | متن توضیحات |
تابع setPlaceholderTextBoxFeedback
//set placeholder text feedback
window.Hantana.setPlaceholderTextBoxFeedback(text);
با استفاده از این تابع میتوانید متن بک گرند نگهدارنده متن ابزارک بازخورد خود را تغییر دهید.
پارامتر های ورودی
| فیلد | نوع | توضیحات | text | String | متن |
تابع hideAfterSendFeedback
//hide feedback after send
window.Hantana.hideAfterSendFeedback(delayTime, flag);
برای پنهان شدن ابزارک بازخورد بعد از ارسال بازخورد توسط کاربر میتوانید از این تابع استفاده نمایید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | Number | مدت زمان تاخیر برای پنهان شدن |
| flag | Boolean | امکان دوباره فعال بودن ابزاک بعد از رفرش صفحه |
تابع openPolls
//open polls
window.Hantana.openPolls(delayTime);
با استفاده از این تابع میتوانید ابزارک نظرسنجی را باز کنید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | Number | زمان تاخیر |
تابع closePolls
//close polls
window.Hantana.closePolls(delayTime);
با استفاده از این تابع میتوانید ابزارک نظرسنجی را ببندید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | Number | زمان تاخیر |
تابع togglePolls
//toggle polls
window.Hantana.togglePolls(delayTime);
این تابع به شما کمک میکند تا اگر ابزارک نظرسنجی روی صفحه باز شده است ان را بسته یا اگر بسته باشد ان را باز کنید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | Number | زمان تاخیر |
تابع setWelcomeMessagePolls
//set wellcome message polls
window.Hantana.setWelcomeMessagePolls(delayTime, showTime, text);
با استفاده از این تابع میتوانید متن خوش آمد گویی برای ابزارک خود فعال کنید.
نکته: این تابع زمانی کار میکند که از پنل پیام خوش آمد گویی هوشمند را غیر فعال نمایید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | String | مدت زمان انتظار تا متن خوش امد گویی نمایش داده شود |
| showTime | String | مدت زمان نمایش متن خوش آمد گویی |
| text | String | متن خوش امد گویی |
تابع setColorButtonPolls
//set color button polls
window.Hantana.setColorButtonPolls(hex);
با استفاده از این تابع میتوانید رنگ دکمه باز کردن ابزاک نظرسنجی را تغییر دهید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| hex | String | کد رنگی را وارد کنید (000000#) |
تابع hideAfterSendPolls
//hide polls after send
window.Hantana.hideAfterSendPolls(delayTime, flag);
برای پنهان شدن ابزارک نظرسنجی بعد از ارسال نظرسنجی توسط کاربر میتوانید از این تابع استفاده نمایید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | String | مدت زمان تاخیر برای پنهان شدن |
| flag | Boolean | امکان دوباره فعال بودن ابزاک بعد از رفرش صفحه |
تابع openSubscribe
//open subscribe
window.Hantana.openSubscribe(delayTime);
با استفاده از این تابع میتوانید ابزارک خبرنامه را باز کنید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | Number | زمان تاخیر |
تابع closeSubscribe
//close subscribe
window.Hantana.closeSubscribe(delayTime);
با استفاده از این تابع میتوانید ابزارک خبرنامه را ببندید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | Number | زمان تاخیر |
تابع toggleSubscribe
//toggle subscribe
window.Hantana.toggleSubscribe(delayTime);
این تابع به شما کمک میکند تا اگر ابزارک خبرنامه روی صفحه باز شده است آن را بسته یا اگر بسته باشد آن را باز کنید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | Number | زمان تاخیر |
تابع setColorButtonSubscribe
//set color button subscribe
window.Hantana.setColorButtonSubscribe(hex);
با استفاده از این تابع میتوانید رنگ دکمه باز کردن ابزارک خبرنامه را تغییر دهید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| hex | String | کد رنگی را وارد کنید (000000#) |
تابع setTitleSubscribe
//set title text subscribe
window.Hantana.setTitleSubscribe(text);
با استفاده از تابع زیر میتوانید عنوان ابزارک خبرنامه خود تغییر دهید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| text | String | متن عنوان ابزارک خبرنامه |
تابع setPlaceholderEmailTextBoxSubscribe
//set placeholder text subscribe email
window.Hantana.setPlaceholderEmailTextBoxSubscribe(text);
با استفاده از این تابع میتوانید متن بک گرند نگهدارنده ایمیل ابزارک خبرنامه خود را تغییر دهید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| text | String | متن |
تابع setPlaceholderMobileTextBoxSubscribe
//set placeholder text subscribe mobile
window.Hantana.setPlaceholderMobileTextBoxSubscribe(text);
با استفاده از این تابع میتوانید متن بک گرند نگهدارنده شماره موبایل ابزارک خبرنامه خود را تغییر دهید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| text | String | متن |
تابع hideAfterSendSubscribe
//hide subscribe after send
window.Hantana.hideAfterSendSubscribe(delayTime, flag);
برای پنهان شدن ابزارک خبرنامه بعد از ارسال خبرنامه توسط کاربر میتوانید از این تابع استفاده نمایید.
پارامتر های ورودی
| فیلد | نوع | توضیحات |
| delayTime | String | مدت زمان تاخیر برای پنهان شدن |
| flag | Boolean | امکان دوباره فعال بودن ابزاک بعد از رفرش صفحه |