/
/
مرجع سریع توسعهدهنده مجموعهای از نمونههای کوتاه و آماده استفاده برای اجرای Provider در کد است. این صفحه برای دسترسی سریع به Syntaxهای رایج مانند اجرای Provider بدون پارامتر، ارسال Parameter، دریافت Structured Output، کار با File و Paging طراحی شده است.
نمونههای زیر الگوهای رایج استفاده از Provider در Custom JS و سناریوهای اجرایی مختلف را نمایش میدهند.
برای Providerهایی که ورودی ندارند، میتوان Provider را فقط با شناسه آن اجرا کرد.
absoluteMethodHelper
.runProvider(PROVIDER_ID)
در صورتی که Provider دارای ورودی باشد، Parameterها بهصورت آرایهای از نام و مقدار ارسال میشوند.
absoluteMethodHelper
.runProvider(
PROVIDER_ID,
[
{
name: 'Id',
value: 1
}
]
)
در Providerهایی که خروجی ساختاریافته برمیگردانند، مقدار providerResult از نتیجه اجرا دریافت و پردازش میشود.
.then(result => {
const rows =
JSON.parse(
result.Content.providerResult || '[]'
);
})
برای ارسال فایل به Provider، فایل بهعنوان مقدار Parameter با نام مورد انتظار Provider ارسال میشود.
{
name: 'file',
value: myFile
}
در سناریوهایی که داده بهصورت Blob دریافت میشود، میتوان آن را به File تبدیل کرده و به Provider ارسال کرد.
const myFile =
new File(
[myBlob],
'file.bin'
);
در Providerهایی که خروجی File دارند، نتیجه دریافتشده از Provider باید بهعنوان فایل پردازش شود.
.then(result => {
const file = result.Content;
saveAs(
file,
file.name
);
})
برای مدیریت خطاهای اجرای Provider میتوان از بخش catch استفاده کرد.
.catch(error => {
console.error(error)
})
برای دریافت دادههای صفحهبندیشده، از متد Paging استفاده میشود. این روش برای مدیریت حجم زیاد داده کاربرد دارد.
providerDesigner
.runProviderPaging(
PROVIDER_ID,
parameters,
pageIndex,
pageSize,
globalFilter,
filters,
orders
)
| پارامتر | توضیح |
|---|---|
| PROVIDER_ID | شناسه Provider |
| parameters | پارامترهای ورودی Provider |
| pageIndex | شماره صفحه مورد نیاز |
| pageSize | تعداد رکوردهای هر صفحه |
| globalFilter | فیلتر کلی |
| filters | فیلترهای اعمالشده |
| orders | ترتیب مرتبسازی دادهها |
این صفحه بهعنوان Cheat Sheet توسعهدهنده طراحی شده است. برای توضیح کامل رفتار هر قابلیت، به صفحات اصلی Provider، File، Result و Paging مراجعه شود.