مستندات

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

Portal.AddContactUsWithProperties

با استفاده از این متد می توان، فیلد هایی را که از طریق افزودن ویژگی ها به دسته مربوطه اضافه گردیده است را، با استفاده از فرم تماس با ما درج کرد.

دقت کنید

با توجه به اینکه CategoryID یکی از ورودی های اجباری متد است، پس باید همیشه یک دسته برای ثبت فرم تماس با ما وجود داشته باشد.

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

Portal.AddContactUsWithProperties (ContactUs, OnSuccess, OnFail);

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

نام	نوع	تعریف
ContactUs	Object	شامل نام، موضوع، دسته، متن پیام، ویژگی ها و ...
OnSuccess	Function	متدی که پس با موفقیت ثبت شدن تماس، اجرا می شود.
OnFail	Function	متدی که در صورت عدم موفقیت در ثبت تماس، اجرا می شود.

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

{
    "IsSuccess": true,
    "StatusCode": 200,
    "Message": "عملیات با موفقیت انجام شد",
    "Result": "FFIT-220308"
}

توضیح مقادیر

Responce

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

توجه

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

Portal.GetObjectContactUs

با استفاده از این متد آبجکت ContactUs که ورودی تابع Portal.AddContactUsWithProperties را می سازیم.

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

Portal.GetObjectContactUs (CategoryID);

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

نام	نوع	تعریف
CategoryID	Number	ID دسته مورد نظر

خروجی تابع

{
    "Name": "",
    "Email": "",
    "Subject": "",
    "Text": "",
    "CategoryId": 887,
    "Mobile": "",
    "Properties": [
        {
            "CategoryID": 887,
            "PropertyID": 1509,
            "Code": "text",
            "Title": "فیلد متنی",
            "Value": "",
            "TypeName": "متن",
            "Description": null,
            "Items": "",
            "TypeID": 74,
            "IsRequired": true,
            "IncludeInSearch": null
        },
        {
            "CategoryID": 887,
            "PropertyID": 1510,
            "Code": "textarea",
            "Title": "فیلد متن چند خطی",
            "Value": "",
            "TypeName": "متن چند خطی",
            "Description": null,
            "Items": "",
            "TypeID": 75,
            "IsRequired": false,
            "IncludeInSearch": null
        },
        {
            "CategoryID": 887,
            "PropertyID": 1511,
            "Code": "email",
            "Title": "فیلد ایمیل",
            "Value": "",
            "TypeName": "ایمیل",
            "Description": null,
            "Items": "",
            "TypeID": 76,
            "IsRequired": true,
            "IncludeInSearch": null
        },
        {
            "CategoryID": 887,
            "PropertyID": 1512,
            "Code": "website",
            "Title": "فیلد آدرس سایت",
            "Value": "",
            "TypeName": "آدرس سایت",
            "Description": null,
            "Items": "",
            "TypeID": 77,
            "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": 1514,
            "Code": "file",
            "Title": "فیلد انتخاب فایل",
            "Value": "",
            "TypeName": "انتخاب فایل",
            "Description": null,
            "Items": "",
            "TypeID": 79,
            "IsRequired": false,
            "IncludeInSearch": null
        },
        {
            "CategoryID": 887,
            "PropertyID": 1515,
            "Code": "date",
            "Title": "فیلد تاریخ",
            "Value": "",
            "TypeName": "تاریخ",
            "Description": null,
            "Items": "",
            "TypeID": 80,
            "IsRequired": false,
            "IncludeInSearch": null
        },
        {
            "CategoryID": 887,
            "PropertyID": 1516,
            "Code": "color",
            "Title": "فیلد رنگ",
            "Value": "",
            "TypeName": "رنگ",
            "Description": null,
            "Items": "",
            "TypeID": 81,
            "IsRequired": false,
            "IncludeInSearch": null
        },
        {
            "CategoryID": 887,
            "PropertyID": 1517,
            "Code": "multiSelect",
            "Title": "فیلد چند انتخابی",
            "Value": "",
            "TypeName": "چند انتخابی",
            "Description": null,
            "Items": "نمونه 1,نمونه 2,نمونه 3,نمونه 4",
            "TypeID": 82,
            "IsRequired": false,
            "IncludeInSearch": null
        },
        {
            "CategoryID": 887,
            "PropertyID": 1518,
            "Code": "select",
            "Title": "فیلد تک انتخابی ",
            "Value": "",
            "TypeName": "تک انتخابی",
            "Description": null,
            "Items": "گزینه 1,گزینه 2,گزینه 3,گزینه 4",
            "TypeID": 83,
            "IsRequired": true,
            "IncludeInSearch": null
        },
        {
            "CategoryID": 887,
            "PropertyID": 1519,
            "Code": "number",
            "Title": "فیلد عددی",
            "Value": "",
            "TypeName": "عدد",
            "Description": null,
            "Items": "",
            "TypeID": 84,
            "IsRequired": false,
            "IncludeInSearch": null
        }
    ]
}

توضیح مقادیر

نام	نوع	اجباری بودن	تعریف
Name	String		نام وارد شده توسط کاربر
Email	String		ایمیل کاربر
Subject	String		عنوان پیام تماس با ما
Text	String		متن پیام کاربر
CategoryId	Number		ID دسته تماس با ما
Mobile	Number		موبایل کاربر
Properties	Array	-	آرایه ای از ویژگی های دسته انتخاب شده.

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	اجباری بودن
IncludeInSearch	Boolean	شرکت در جستجو (این فیلد فقط در محصول کاربرد دارد).

نکته

متد Portal.GetObjectContactUs آبجکت ورودی تابع Portal.AddContactUsWithProperties را ایجاد میکند سپس ما آن را با توجه به مقادیری که کاربر در فرم وارد کرده پر می کنیم و به متد اصلی ارسال می کنیم.

توجه

با توجه به توضیحاتی که داده شد، بدیهی است که باید فرم تماس با ما را طبق ویژگی های دسته انتخاب شده (چه در آپشن ها و توسط سازنده سایت و چه در خود فرم تماس با ما) ایجاد کنید یا تغییر کنید.

مثال ها

مثال ساده

در این مثال یک دسته توسط ایجاد کننده سایت برای تماس با ما انتخاب شده و ما فرم را با توجه به آن ایجاد می کنیم. ID این دسته 887 است.

فرم تماس با ما همراه با ویژگی

تماس با ما

نام و نام خانوادگی

ایمیل

موبایل

موضوع

متن پیام

نکته

جهت ثبت فایل و تصویر وارد شده توسط کاربر می بایست id المان انتخاب عکس و فایل را به متد بدهیم.

توجه

دقت داشته باشید که هنگام انتصاب به value، در ویژگی های تک انتخابی و چند انتخابی، فاصله ها را به زیر خط (_) تبدیل کنید، در غیر اینصورت با خطا مواجه می شوید.

توجه

در صورتی که به کاربر کد پیگیری تماس را نمایش میدهید، بهتر است آن را توسط متدی در کوکی ذخیره کنید.