مستندات

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

Portal.GetContentCategories

از این متد برای دریافت دسته های محتوا استفاده می شود. از دسته های محتوا عموما برای نمایش در ساید صفحات یا ماژول های تب برگی و ... استفاده می شود.

نکته

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

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

Portal.GetContentCategories (TemplateName, ElementId, AfterFunction);

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

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

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

{
    "IsSuccess": true,
    "StatusCode": 200,
    "Message": "عملیات با موفقیت انجام شد",
    "Result": [
        {
            "ID": 475,
            "ParentID": null,
            "TreeLevel": 1,
            "IsActive": null,
            "CategoryName": "بازی و سرگرمی",
            "Icon_Address": "/Files/2/Contents/CategoryPic/game2.jpg",
            "Header_Pic_Address": "/Files/2/Contents/CategoryPic/game3.jpg",
            "Small_Pic_Address": "/Files/2/Contents/CategoryPic/game4.jpg",
            "Large_Pic_Address": "",
            "Description": "menu",
            "Code": "games",
            "IsImportant": false,
            "TableName": null,
            "RibbonGroup_ID": null,
            "IsAutoCode": null,
            "AutoCodeNumbers": null,
            "Count": 57,
            "Priority": 475,
            "Properties": [],
            "childs": []
        },
        {
            "ID": 773,
            "ParentID": null,
            "TreeLevel": 1,
            "IsActive": null,
            "CategoryName": "گردشگری",
            "Icon_Address": "/Files/2/Contents/CategoryPic/tourism7.png",
            "Header_Pic_Address": "/Files/2/Contents/CategoryPic/tourism10.jpg",
            "Small_Pic_Address": "/Files/2/Contents/CategoryPic/tourism1.png",
            "Large_Pic_Address": "",
            "Description": "menu",
            "Code": "Tourism",
            "IsImportant": false,
            "TableName": null,
            "RibbonGroup_ID": null,
            "IsAutoCode": null,
            "AutoCodeNumbers": null,
            "Count": 0,
            "Priority": 773,
            "Properties": [],
            "childs": [
                {
                    "ID": 290,
                    "ParentID": 773,
                    "TreeLevel": 2,
                    "IsActive": null,
                    "CategoryName": "کشور ها",
                    "Icon_Address": "/Files/2/Contents/CategoryPic/countries6.png",
                    "Header_Pic_Address": "/Files/2/Contents/CategoryPic/countries1.jpg",
                    "Small_Pic_Address": "/Files/2/Contents/CategoryPic/countries5.png",
                    "Large_Pic_Address": "",
                    "Description": "2",
                    "Code": "countries",
                    "IsImportant": false,
                    "TableName": null,
                    "RibbonGroup_ID": null,
                    "IsAutoCode": null,
                    "AutoCodeNumbers": null,
                    "Count": 15,
                    "Priority": 290,
                    "Properties": [],
                    "childs": []
                },
                {
                    "ID": 300,
                    "ParentID": 773,
                    "TreeLevel": 2,
                    "IsActive": null,
                    "CategoryName": "اماکن تفریحی",
                    "Icon_Address": "/Files/2/Contents/CategoryPic/Recreational-places10.png",
                    "Header_Pic_Address": "/Files/2/Contents/CategoryPic/Recreational-places.jpg",
                    "Small_Pic_Address": "/Files/2/Contents/CategoryPic/Recreational-places4.png",
                    "Large_Pic_Address": "",
                    "Description": "4",
                    "Code": "Recreational-places",
                    "IsImportant": false,
                    "TableName": null,
                    "RibbonGroup_ID": null,
                    "IsAutoCode": null,
                    "AutoCodeNumbers": null,
                    "Count": 31,
                    "Priority": 300,
                    "Properties": [],
                    "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 تعداد محتواهای مستقیم این دسته
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.ContentCategories

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

Portal.GetContactCategories

Portal.GetContentCategoryIDByCode

این متد با دریافت کد دسته، ID آن را باز میگرداند.

Portal.GetContentCategoryIDByCode (Code);

Portal.GetContentCategoryIDsByParentCode

این متد با دریافت کد دسته، ID دسته های فرزند آن دسته را به صورت یک آرایه عددی باز میگرداند.

Portal.GetContentCategoryIDsByParentCode (Code);

توجه

قبل از استفاده از دو متد بالا Portal.GetContentCategoryIDByCode و Portal.GetContentCategoryIDsByParentCode حتما باید متد Portal.GetContentCategories را صدا زده باشید.