پرش به مطلب اصلی

ویجت و اکشن های دیوار (UI در کنار)

ویجت‌ها اجزای تشکیل دهندهٔ صفحات در دیوار هستند، که برخی از آنها را می‌توانید در افزونه‌های خود استفاده کنید. برای درج یک ویجت در یک افزونه باید نام ویجت و جزییات مرتبط با آن را همراه درخواست درج افزونه ارسال کنید.

اکشن‌ها در ویجت‌ها​

بسیاری از ویجت‌ها قابلیت اجرای اکشن (Action) دارند. اکشن‌ها امکان تعامل کاربر با ویجت‌ها را فراهم می‌کنند و می‌توانند اعمال مختلفی مانند باز کردن لینک، ارسال درخواست به سرور، یا اجرای عملیات خاص در رابط کاربری دیوار را انجام دهند.

برای اطلاعات کامل درباره انواع اکشن‌ها و نحوه استفاده از آنها، مستندات اکشن‌ها را مطالعه کنید.

به عنوان مثال ، در ریکوئست ساخت اند آن میتواند این اطلاعات وجود داشته باشد:

مثال:

{
  "widgets": [
    {
      "description_row": {
        "text": "این یک دسکریپشن رو هست",
        "has_divider": false,
        "expandable": false
      },
      "semantic_paths": {
        "a sample sentence": "text"
      }
    },
    {
      "event_row": {
        "title": "یه تایتل مناسب",
        "subtitle": "یه زیر تایتل مناسب تر",
        "label": "یه لیبل زیبا",
        "image_id": "someuuid.jpg",
        "has_divider": true,
        "icon_name": "ADD",
        "action": {
          "open_direct_link": "https://example.com"
        }
      },
      "semantic_paths": {
        "user_face": "image_id",
        "example_link": "action.open_direct_link"
      }
    }
  ]
}

اطلاعاتی که درون widgets قرار دارد ، لیستی از ویجت ها و ساختار داده‌هایی است که دیوار برای نمایش اطلاعات پشتیبانی می‌کنند. هر ویجت ویژگی‌های خود را دارد که در ابجکتی در فیلدی با مقدار نام خودش می‌توان تعیینشان کرد. مثلاً با true گذاشتن مقدار divider برای ویجت‌هایی که این ویژگی را دارند، می‌توان یک خط جدا کننده زیر ویجت نمایش داد.

ساختار کلی هر ویجت:

{
  widget_name_in_snake_case: {
    // this is referred to as widget data
    // fields
  },
  semantic_paths: {
    "key for an information you want to relay": "path to the field from the widget data object",
  },
}

اطلاعات معنایی ویجتی​

شما می‌توانید با استفاده از فیلد semantic_paths واقع کنار دیتای ویجت اطلاعاتی معنایی درباره فیلد های داخلی ویجت بدهید. در فیلد semantic_paths یک object جیسون وجود دارد که تمام value هایش string است. در value یک fieldmask_path قرار میگیرد که همانند jsonpath می‌باشد ولی از اندیس آرایه نمی‌توان استفاده کرد. مسیر از داخل دیتای ویجت شروع میشود به طور مثال اگر داشته باشیم:

{
  "event_row": {
    "title": "یه تایتل مناسب",
    "subtitle": "یه زیر تایتل مناسب تر",
    "label": "یه لیبل زیبا",
    "image_id": "someuuid.jpg",
    "has_divider": true,
    "icon_name": "ADD",
    "action": {
      "open_direct_link": "https://google.com"
    }
  },
  "semantic_paths": {
    "user_face": "image_id",
    "my_link": "action.open_direct_link"
  }
}

که دیوار نتیجه اطلاعات معنایی زیر را دارد:

{
  "user_face": "someuuid.jpg",
  "my_link": "https://google.com"
}

از این اطلاعات می‌توان برای ارتباط با تیم های دیواری استفاده کنید.

ویژگی‌های ویجت‌ها​

ویژگی‌های هر ویجت، شرایط اعتبار سنجی و توضیحات مرتبط هر کدام در صفحات زیر دسترس‌ است.

ویجت‌های دارای تصویر​

برای اطلاع از درج تصویر در ویجت‌هایی که امکان نمایش تصویر در قسمتی از خود را دارند، صفحهٔ تصاویر در ویجت‌ها را ببینید

لیست ویجت های کنار دیوار

فایل فیگمای ویجت‌ها و آیکون‌ها​