مستندات

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

Portal.GetContactUsCategory

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

نکته

دسته های این قسمت نیز مانند تمامی بخش ها دارای ویژگی Properties هستند.

توجه

از ویژگی های دسته ها تماس برای ایجاد فیلدهای مختص هر دسته، در فرم تماس با ما استفاده می شود.

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

Portal.GetContactUsCategory (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": "suport",
            "IsImportant": false,
            "Priority": 887,
            "TableName": null,
            "RibbonGroup_ID": null,
            "IsAutoCode": null,
            "AutoCodeNumbers": null,
            "Count": 0,
            "Properties": [],
            "childs": [
                {
                    "ID": 888,
                    "ParentID": 887,
                    "TreeLevel": 2,
                    "IsActive": null,
                    "CategoryName": "مرجوعی کالا",
                    "Icon_Address": "",
                    "Header_Pic_Address": "",
                    "Small_Pic_Address": "",
                    "Large_Pic_Address": "",
                    "Description": null,
                    "Code": "return",
                    "IsImportant": false,
                    "Priority": 888,
                    "TableName": null,
                    "RibbonGroup_ID": null,
                    "IsAutoCode": null,
                    "AutoCodeNumbers": null,
                    "Count": 0,
                    "Properties": [
                        {
                            "CategoryID": 887,
                            "PropertyID": 1509,
                            "Code": "productCode",
                            "Title": "کد محصول",
                            "Value": "",
                            "TypeName": "متن",
                            "Description": null,
                            "Items": "",
                            "TypeID": 74,
                            "IsRequired": true,
                            "IncludeInSearch": null
                        },
                        {
                            "CategoryID": 887,
                            "PropertyID": 1510,
                            "Code": "reason",
                            "Title": "دلیل مرجوع کردن",
                            "Value": "",
                            "TypeName": "متن چند خطی",
                            "Description": null,
                            "Items": "",
                            "TypeID": 75,
                            "IsRequired": false,
                            "IncludeInSearch": null
                        },
                        {
                            "CategoryID": 887,
                            "PropertyID": 1513,
                            "Code": "image",
                            "Title": "تصویر محصول",
                            "Value": "",
                            "TypeName": "انتخاب تصویر",
                            "Description": null,
                            "Items": "",
                            "TypeID": 78,
                            "IsRequired": false,
                            "IncludeInSearch": null
                        },
                        {
                            "CategoryID": 887,
                            "PropertyID": 1518,
                            "Code": "Replacement",
                            "Title": "آیا مایل به معاوضه هستید",
                            "Value": "",
                            "TypeName": "تک انتخابی",
                            "Description": null,
                            "Items": "بله،خیر",
                            "TypeID": 83,
                            "IsRequired": true,
                            "IncludeInSearch": null
                        }
                    ],
                    "childs": []
                }
            ]
        }
    ]
}

توضیح مقادیر

Responce

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

Result

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

Properties

نام نوع توضیح
CategoryID Number ID دسته
PropertyID Number ID ویژگی
Code String کد ویژگی (این فیلد مهم است چون ما ویژگی ها را با استفاده از کد میابیم).
Title String عنوان ویژگی
Value String مقدار ویژگی (این فیلد در دسته همیشه خالی است.)
TypeName String نام نوع ویژگی که شامل: متن، متن چند خطی، ایمیل، آدرس وبسایت، انتخاب تصویر، انتخاب سایت، تاریخ، رنگ، چند انتخابی، تگ انتخابی و عدد می شود.
Description String توضیحات
Items String در صورتی که ویژگی از نوع تک انتخابی یا چند انتخابی باشد این فیلد مقدار می گیرد. آیتم ها با ویرگول (،) از هم تفکیک می شوند.
TypeID Number ID نوع ویژگی، ما با استفاده از این فیلد نوع ویژگی را تشخیص می دهیم و اینپوت متناسب را در فرم تماس ایجاد می کنیم. که به این صورت هستند:
74 متن تک خطی
75 متن چند خطی
76 ایمیل
77 آدرس سایت
78 انتخاب تصویر
79 انتخاب فایل
80 تاریخ
81 رنگ
82 چند انتخابی
83 تک انتخابی
84 عدد
IsRequired Boolean اجباری بودن، در صورتی که این فیلد true باشد به این معنی است که دریافت مقدار آن از کاربر اجباری است.
IncludeInSearch Boolean آیا مقدار این ویژگی در جستجو لحاظ شود. (این فیلد در واقع فقط برای داخل پورتال است و هیچ استفاده ای در UI ندارد).

Portal.ContactUsCategory

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

Portal.GetContactUsCategory

توجه

نمونه استفاده از این متد را در متد Portal.AddContactUs می توانید مشاده کنید.