مستندات

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

Portal.Category.GetBreadcrumb

از این متد برای ایجاد Breadcrumb در سایت ها استفاده می شود. به این صورت که ID دسته فعلی را دریافت می کند و آن دسته به همراه پدر یا پدرانش را به صورت یک لیست فلت (flat) به ما برمیگرداند.

نکته

این متد بدون توجه به نوع دسته که محتوایی، محصول، لینک یا ... است، دسته های مورد نظر ما را برمیگرداند.

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

Portal.Category.GetBreadcrumb (CategoryID, TemplateName, ElementId, AfterFunction, FailFunction);

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

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

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

{
    "IsSuccess": true,
    "StatusCode": 200,
    "Message": "عملیات با موفقیت انجام شد",
    "Result": [
        {
            "ID": 897,
            "ParentID": 371,
            "TreeLevel": 3,
            "IsActive": true,
            "CategoryName": "سنتی",
            "Icon_Address": "",
            "Header_Pic_Address": "",
            "Small_Pic_Address": "",
            "Large_Pic_Address": "",
            "Description": null,
            "Code": "sonnati",
            "IsImportant": false,
            "TableName": "tbl_cms_contents",
            "RibbonGroup_ID": null,
            "IsAutoCode": false,
            "AutoCodeNumbers": 0,
            "Count": null,
            "Priority": 897,
            "Properties": null,
            "childs": null
        },
        {
            "ID": 371,
            "ParentID": 775,
            "TreeLevel": 2,
            "IsActive": true,
            "CategoryName": "موسیقی",
            "Icon_Address": "/Files/2/Contents/CategoryPic/music3.png",
            "Header_Pic_Address": "/Files/2/Contents/CategoryPic/music5.jpg",
            "Small_Pic_Address": "/Files/2/Contents/CategoryPic/music8.jpg",
            "Large_Pic_Address": "",
            "Description": "5",
            "Code": "music",
            "IsImportant": false,
            "TableName": "tbl_cms_contents",
            "RibbonGroup_ID": null,
            "IsAutoCode": false,
            "AutoCodeNumbers": 0,
            "Count": null,
            "Priority": 371,
            "Properties": null,
            "childs": null
        },
        {
            "ID": 775,
            "ParentID": null,
            "TreeLevel": 1,
            "IsActive": true,
            "CategoryName": "هنر و معماری",
            "Icon_Address": "/Files/2/Contents/CategoryPic/art4.webp",
            "Header_Pic_Address": "/Files/2/Contents/CategoryPic/art6.jpg",
            "Small_Pic_Address": "/Files/2/Contents/CategoryPic/art2.png",
            "Large_Pic_Address": "",
            "Description": "menu",
            "Code": "art",
            "IsImportant": false,
            "TableName": "tbl_cms_contents",
            "RibbonGroup_ID": null,
            "IsAutoCode": false,
            "AutoCodeNumbers": 0,
            "Count": null,
            "Priority": 775,
            "Properties": null,
            "childs": null
        }
    ]
}

توضیح مقادیر

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 ندارد).