مستندات

لیست دسته ها و محتواها

Portal.GetFAQCategories

از این متد برای دریافت دسته های پرسش های متداول استفاده می شود.

نکته

دسته ی هر تماسی که تیک Faq آن خورده باشد در لیست دسته های پرسش های متداول می آید.

طریقه استفاده از متد:

Portal.GetFAQCategories (TemplateName, ElementId, AfterFunction);

ورودی های تابع

نام	نوع	مقدار پیشفرض	تعریف
TemplateName	String	-	ID تگ script که با استفاده از آن ظاهر هر محتوا ساخته می شود.
ElementId	String	-	ID تگی که قرار است محتواها در آن قرار داده شوند.
AfterFunction	Function	-	تابعی که بعد از اجرا شدن این متد اجرا می شود (callback function).

مقدار دریافتی (Responce)

{
    "IsSuccess": true,
    "StatusCode": 200,
    "Message": "عملیات با موفقیت انجام شد",
    "Result": [
        {
            "ID": 887,
            "ParentID": null,
            "TreeLevel": 1,
            "IsActive": null,
            "CategoryName": "دسته تماس با ما تستی",
            "Icon_Address": "",
            "Header_Pic_Address": "",
            "Small_Pic_Address": "",
            "Large_Pic_Address": "",
            "Description": null,
            "Code": "test",
            "IsImportant": false,
            "TableName": null,
            "RibbonGroup_ID": null,
            "IsAutoCode": null,
            "AutoCodeNumbers": null,
            "Count": null,
            "Properties": null,
            "childs": null
        },
        {
            "ID": 888,
            "ParentID": 887,
            "TreeLevel": 2,
            "IsActive": null,
            "CategoryName": "پشتیبانی",
            "Icon_Address": "",
            "Header_Pic_Address": "",
            "Small_Pic_Address": "",
            "Large_Pic_Address": "",
            "Description": null,
            "Code": "support",
            "IsImportant": false,
            "TableName": null,
            "RibbonGroup_ID": null,
            "IsAutoCode": null,
            "AutoCodeNumbers": null,
            "Count": null,
            "Properties": null,
            "childs": null
        }
    ]
}

توضیح مقادیر

Responce

نام	نوع	توضیح
IsSuccess	Boolean	درصورت موفقیت آمیز بودن دریافت محتوا این پارامتر true می شود.
StatusCode	Number	وضعیت دریافت پاسخ، اگر 200 باشد یعنی موفقیت آمیز بوده
Message	String	پیغام موفقیت یا عدم موفقیت دریافت پاسخ
Result	Object	نتیجه ی دریافت پاسخ

Result

نام	نوع	توضیح
ID	Number	ID دسته
ParentID	Number	ID دسته پدر (درصورتی که دسته فعلی خودش پدر باشد null میشود).
TreeLevel	Number	سطح دسته در درخت دسته ها که از 1 شروع می شود.
IsActive	Boolean	فعال بودن دسته
CategoryName	String	نام دسته
Icon_Address	String	تصویر آیکون
Header_Pic_Address	String	تصویر سربرگ
Small_Pic_Address	String	تصویر کوچک
Large_Pic_Address	String	تصویر بزرگ
Description	String	متن توضیحات دسته
Code	String	کد دسته (اجباری)
IsImportant	Boolean	مهم بودن
TableName	String	مقدار این فیلد همیشه null است و استفاده نمی شود.
RibbonGroup_ID	Number	ID تب توسعه (این فیلد همیشه null است و استفاده نمی شود).
IsAutoCode	Boolean	ایجاد کد به صورت اوتوماتیک (این فیلد تماس ها استفاده نمی شود).
AutoCodeNumbers	Number	تعداد اعداد کد خودکار (این فیلد نیز در تماس ها استفاده نمی شود).
Count	Number	تعداد تماس های این دسته (این فیلد نیز در تماس ها همیشه 0 است.)
Properties	Array	لیست ویژگی ها که در این لیست null می آید.
childs	Array	لیست زیر دسته های، دسته جاری (دسته های بچه) که در این لیست null می آید.

Portal.FAQCategories

این متغیر در صورتیکه یک با Portal.GetFAQCategories در صفحه صدا زده شود با مقدار Responce پر می شود.
پس با استفاده از این متغیر از صدا کردن چندباره متد و Request زدن اضافه جلوگیری می کنیم.

Portal.GetFAQCategories