استفاده از کتابخانه JavaScript اپسان (AppsanWeb) برای توسعه‌دهندگان

کتابخانه JavaScript اپسان وب با هدف تسهیل ارتباط بین صفحات وب و پلتفرم اپسان طراحی شده است. این مستند به شما کمک می‌کند تا از این کتابخانه در وب‌سایت‌های خود استفاده کنید.

نصب کتابخانه

برای نصب کتابخانه اپسان، کافی است از npm استفاده کنید:

npm i @appsan-web/mini-web-sdk

لینک کتابخانه

راه‌اندازی کتابخانه

در ابتدا نیاز است که کتابخانه را در پروژه خود وارد کنید:

import {AppsanWeb} from '@appsan-web/mini-web-sdk';

استفاده از کلاس AppsanWeb

کلاس اصلی برای تعامل با اپسان، AppsanWeb است. این کلاس مسئول مدیریت ارتباطات بین وب‌سایت شما و صفحه اپسان است.

1. راه‌اندازی اولیه:

برای راه‌اندازی کتابخانه کافی است تابع initialize را فراخوانی کنید. این تابع به صورت خودکار کتابخانه را بعد از بارگذاری کامل صفحه وب شما فعال می‌کند.

AppsanWeb.initialize();

2. وضعیت آماده بودن اپسان:

می‌توانید با استفاده از getStatus() وضعیت آماده بودن اپسان را بررسی کنید. این تابع یک BehaviorSubject از نوع استرینگ باز می‌گرداند که می‌توانید به تغییرات آن گوش دهید:

const status$ = AppsanWeb.getStatus();
status$.subscribe(status => {
  console.log("Appsan Status:", status);
});

:وضعیت میتواند یکی از مقادیر زیر باشد

"not ready"
"ready"
"not available"
"error"

3. اجرای اکشن در اپسان:

تابع runAction برای اجرای اکشن در اپسان استفاده می شود.

AppsanWeb.runAction('myAction').subscribe();

4. مدیریت دکمه بازگشت:

برای کنترل رفتار دکمه بازگشت از متد setCustomBackHandler استفاده کنید در حالت پیشفرض اپسان هیستوری مینی وب شما را مدیریت میکند و این تابع تنها برای مدیریت پیشرفته ی بازگشت استفاده می شود.

AppsanWeb.setCustomBackHandler(() => {
  // Custom back behavior
});

5. ارسال درخواست HTTP:

برای ارسال درخواست HTTP می‌توانید از متد httpCall استفاده کنید. به این صورت:

AppsanWeb.httpCall('https://api.example.com', 'GET', {}, {}).subscribe(response => {
  console.log('HTTP Response:', response);
});

6. دریافت اطلاعات بایند (Bind)

متد getBind برای دریافت اطلاعات یک بایند (Bind) خاص از اپسان استفاده می‌شود. این متد یک Subject برمی‌گرداند که می‌توانید به آن subscribe کنید تا اطلاعات بایند را دریافت کنید:

AppsanWeb.getBind('myBind').subscribe(data => {
  console.log('Bind data:', data);
});

7. تنظیم مقدار متغیر

با استفاده از متد setVariable می‌توانید مقدار یک متغیر را در اپسان تنظیم کنید.

AppsanWeb.setVariable('variableId', 'newValue').subscribe();

8. دریافت مقدار متغیر

برای دریافت مقدار یک متغیر از اپسان از متد getVariable استفاده می‌کنید. این متد نیز یک Subject برمی‌گرداند که می‌توانید مقدار متغیر را با آن دریافت کنید:

AppsanWeb.getVariable('variableId').subscribe(variable => {
  console.log('Variable:', variable);
});