مستندات

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

Portal.GetFAQs

از این متد برای دریافت یک پرسش متداول یا لیستی از پرسش های متداول استفاده می شود. این متد شامل جستجوی متنی و فیلتر بر اساس دسته و همچنین مکانیزم صفحه بندی هم می شود.

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

Portal.GetFAQs (Options, TemplateName, ElementId, AfterFunction);

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

نام نوع مقدار پیشفرض تعریف
Term String null عبارتی که جستجو شده
ID Number null ID یک پرسش متداول را دریافت می کند و فقط آن را بر میگرداند.
در صورتی که این کلید مقدار دهی شده باشد مقادیر دیگر کلید ها نادیده گرفته می شوند.
CategoryIDs Array [] آرایه ای از ID دسته های مورد نظرتان را دریافت می کند.
PageSize Number 10 تعداد پرسش متداولی که در هر صفحه میخواهید نمایش بدهید.
PageNumber Number 1 شماره صفحه مورد نظرتان را دریافت می کند.

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

{
    "IsSuccess": true,
    "StatusCode": 200,
    "Message": "عملیات با موفقیت انجام شد",
    "Result": {
      "PageNumber": 1,
      "PageSize": 10,
      "PagesCount": 1,
      "RecordsCount": 2,
      "Records": [
        {
          "ID": 2749,
          "Subject": "لورم ایپسوم متن ساختگی 12",
          "Question": "لورم ایپسوم متن ساختگی با تولید سادگی نامفهوم از صنعت چاپ و با استفاده از طراحان گرافیک است. چاپگرها و متون بلکه روزنامه و مجله در ستون و سطرآنچنان که لازم است و برای شرایط فعلی تکنولوژی مورد نیاز و کاربردهای متنوع با هدف بهبود ابزارهای کاربردی می باشد؟\n",
          "QuestionDate": "2022-03-30T21:30:44.693",
          "Answer": " مداد رنگی ها مشغول بودند به جز مداد سفید، هیچکس به او کار نمیداد، همه میگفتند : تو به هیچ دردی نمیخوری، یک شب که مداد رنگی ها تو سیاهی شب گم شده بودند، مداد سفید تا صبح ماه کشید مهتاب کشید و انقدر ستاره کشید که کوچک و کوچکتر شد صبح توی جعبه مداد رنگی جای خالی او با هیچ رنگی  پر نشد، به یاد هم باشیم شاید فردا ما هم در کنار هم نباشیم…",
          "AnswerDate": "2022-03-30T21:31:20.753",
          "Category_ID": 888,
          "Category_Name": "پشتیبانی"
        },
        {
          "ID": 2748,
          "Subject": "لورم ایپسوم متن ساختگی 11",
          "Question": "لورم ایپسوم متن ساختگی با تولید سادگی نامفهوم از صنعت چاپ و با استفاده از طراحان گرافیک است. چاپگرها و متون بلکه روزنامه و مجله در ستون و سطرآنچنان که لازم است و برای شرایط فعلی تکنولوژی مورد نیاز و کاربردهای متنوع با هدف بهبود ابزارهای کاربردی می باشد؟",
          "QuestionDate": "2022-03-30T21:30:18.553",
          "Answer": "خالد حسینی تو رمان باد بادک باز مینویسه : ﻣﺮﺩ ﺁﻫﺴﺘﻪ ﺩﺭ ﮔﻮﺵ ﻓﺮﺯﻧﺪ ﺗﺎﺯﻩ ﺑﻪ ﺑﻠﻮﻍ ﺭﺳﯿﺪﻩ ﺍﺵ ﺑﺮﺍﯼ ﭘﻨﺪ ﭼﻨﯿﻦ ﻧﺠﻮﺍ ﮐﺮﺩ : ” ﭘﺴﺮﻡ ﺩﺭ ﺯﻧﺪﮔﯽ ﻫﺮﮔﺰ ﺩﺯﺩﯼ ﻧﮑﻦ ” ﭘﺴﺮ ﻣﺘﻌﺠﺐ ﻭ ﻣﺒﻬﻮﺕ ﺑﻪ ﭘﺪﺭ ﻧﮕﺎﻩ ﮐﺮﺩ ﺑﺪﯾﻦ ﻣﻌﻨﺎ ﮐﻪ ﺍﻭ ﻫﺮﮔﺰ ﺩﺳﺖ ﮐﺞ ﻧﺪﺍﺷﺘﻪ ﭘﺪﺭ ﺑﻪ ﻧﮕﺎﻩ ﻣﺘﻌﺠﺐ ﻓﺮﺯﻧﺪ ﻟﺒﺨﻨﺪﯼ ﺯﺩ ﻭ ﺍﺩﺍﻣﻪ ﺩﺍﺩ : ﺩﺭ ﺯﻧﺪﮔﯽ ﺩﺭﻭﻍ ﻧﮕﻮ ﭼﺮﺍ ﮐﻪ ﺍﮔﺮ ﮔﻔﺘﯽ ﺻﺪﺍﻗﺖ ﺭﺍ ﺩﺯﺩﯾﺪﻩ ﺍﯼ، ﺧﯿﺎﻧﺖ ﻧﮑﻦ ﮐﻪ ﺍﮔﺮ ﮐﺮﺩﯼ ﻋﺸﻖ ﺭﺍ ﺩﺯﺩﯾﺪﻩ ﺍﯼ، ﺧﺸﻮﻧﺖ ﻧﮑﻦ ﺍﮔﺮ ﮐﺮﺩﯼ ﻣﺤﺒﺖ ﺭﺍ ﺩﺯﺩﯾﺪﻩ ﺍﯼ، ﻧﺎ ﺣﻖ ﻧﮕﻮ ﺍﮔﺮ ﮔﻔﺘﯽ ﺣﻖ ﺭﺍ ﺩﺯﺩﯾﺪﻩ ﺍﯼ، ﺑﯽ ﺣﯿﺎﯾﯽ ﻧﮑﻦ ﺍﮔﺮ ﮐﺮﺩﯼ ﺷﺮﺍﻓﺖ ﺭﺍ ﺩﺯﺩﯾﺪﻩ ﺍی... ﭘﺲ ﺩﺭ ﺯﻧﺪﮔﯽ ﻓﻘﻂ ﺩﺯﺩﯼ نکن !",
          "AnswerDate": "2022-03-30T21:31:35.8",
          "Category_ID": 888,
          "Category_Name": "پشتیبانی"
        }
      ]
    }
  }

توضیح مقادیر

Responce

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

Result

نام نوع توضیح
PageSize Number تعداد پرسش ها در هر صفحه
PageNumber Number شماره صفحه
PagesCount Number تعداد صفحات
RecordsCount Number تعداد کل پرسش های متداول
Records Array آرایه ای از آبجکت ها که هر کدام از آنها شامل اطلاعات یک پرسش متداول است.

Records

نام نوع توضیح
ID Number ID پرسش متداول
Subject String عنوان پرسش
Question String متن پرسش
QuestionDate String تاریخ و زمان ثبت پرسش
Answer String متن پاسخ
AnswerDate String تاریخ و زمان ثبت پاسخ
Category_ID Number ID دسته پرسش متداول
Category_Name String نام دسته

مثال ها

مثال جامع

در این مثال در قسمت سمت چپ یک باکس جستجو وجود دارد که هرچه کاربر جستجو کند در قسمت سمت راست نتیجه را نمایش می دهد، و همچنین دسته های پرسش ها و پاسخ های متداول لیست شده اند، که با کلیک روی هر دسته محتوای آن در سمت راست نمایش داده می شود.

مثال جامع

مثال نمایش یک پرسش و پاسخ

برای مثال قرار است هر سوال در یک صفحه قرار بگیرد و یک لینک که توسط ID هر پرسش و پاسخ یکتا شده، داشته باشد. در اینصورت از روش زیر استفاده می کنیم.
این روش برای ارسال و دریافت لینک پرسش ها و سئو کردن آنها استفاده می شود.

نمایش یک پرسش و پاسخ