You are here

Home » API reference » Flag 8.4

flag.schema.yml in Flag 8.4

config/schema/flag.schema.yml

File

config/schema/flag.schema.yml
View source 
  1. flag.flag.*:

  2.   type: config_entity

  3.   label: 'Flag'

  4.   mapping:

  5.     id:

  6.       type: string

  7.       label: 'Flag identifier'

  8.     uuid:

  9.       type: string

  10.       label: 'UUID'

  11.     label:

  12.       type: label

  13.       label: 'Name'

  14.     bundles:

  15.       type: sequence

  16.       label: 'The entity bundles this flag applies to'

  17.       sequence:

  18.         - type: string

  19.     entity_type:

  20.       type: string

  21.       label: 'Flaggable entity type'

  22.     global:

  23.       type: boolean

  24.       label: 'Whether the flag is global'

  25.     flag_short:

  26.       type: label

  27.       label: 'Flag link text'

  28.     flag_long:

  29.       type: label

  30.       label: 'Flag link description text'

  31.     flag_message:

  32.       type: label

  33.       label: 'Flag message'

  34.     unflag_short:

  35.       type: label

  36.       label: 'Unflag link text'

  37.     unflag_long:

  38.       type: label

  39.       label: 'Unflag link description text'

  40.     unflag_message:

  41.       type: label

  42.       label: 'Unflag message'

  43.     unflag_denied_text:

  44.       type: label

  45.       label: 'Unflag denied text'

  46.     weight:

  47.       type: integer

  48.       label: 'Weight'

  49.     flag_type:

  50.       type: string

  51.       label: 'ID of the Flag Type plugin'

  52.     link_type:

  53.       type: string

  54.       label: 'ID of the Link Type plugin'

  55.     flagTypeConfig:

  56.       type: flag.flag_type.plugin.[%parent.flag_type]

  57.       label: 'Flag type configuration'

  58.     linkTypeConfig:

  59.       type: flag.link_type.plugin.[%parent.link_type]

  60.       label: 'Link type configuration'

  61. 

  62. "flag.flag_type.plugin.entity:*":

  63.   type: mapping

  64.   label: 'Flag type for all entity types'

  65.   mapping:

  66.     show_in_links:

  67.       type: sequence

  68.       label: 'Show in links'

  69.       sequence:

  70.         type: string

  71.         label: 'View mode'

  72.     show_as_field:

  73.       type: boolean

  74.       label: 'Show as field'

  75.     show_on_form:

  76.       type: boolean

  77.       label: 'Show on form'

  78.     show_contextual_link:

  79.       type: boolean

  80.       label: 'Show contextual link'

  81.     extra_permissions:

  82.       type: sequence

  83.       label: 'Extra permissions'

  84.       sequence:

  85.         type: string

  86.         label: 'Extra permission option'

  87. 

  88. flag.flag_type.plugin.entity:user:

  89.   type: "flag.flag_type.plugin.entity:*"

  90.   label: 'Flag type for user entities'

  91.   mapping:

  92.     show_on_profile:

  93.       type: boolean

  94.       label: 'Show on profile'

  95. 

  96. flag.link_type.plugin.*:

  97.   type: mapping

  98.   label: 'Link type configuration'

  99. 

  100. flag.link_type.plugin.confirm:

  101.   type: mapping

  102.   label: 'Confirm Form link type'

  103.   mapping:

  104.     flag_confirmation:

  105.       type: label

  106.       label: 'Flag confirmation'

  107.     unflag_confirmation:

  108.        type: label

  109.        label: 'Unflag confirmation'

  110.     flag_create_button:

  111.       type: label

  112.       label: 'Create flagging button text'

  113.     flag_delete_button:

  114.       type: label

  115.       label: 'Delete flagging button text'

  116.     flag_update_button:

  117.       type: label

  118.       label: 'Update flagging button text'

  119.     form_behavior:

  120.       type: string

  121.       label: 'Where should the form open (new page, modal, etc)'

  122. 

  123. flag.link_type.plugin.field_entry:

  124.   type: mapping

  125.   label: 'Field Entry link type'

  126.   mapping:

  127.     flag_confirmation:

  128.       type: label

  129.       label: 'Flag confirmation'

  130.     edit_flagging:

  131.       type: label

  132.       label: 'Edit flagging'

  133.     unflag_confirmation:

  134.       type: label

  135.       label: 'Unflag confirmation'

  136.     flag_create_button:

  137.       type: label

  138.       label: 'Create flagging button text'

  139.     flag_delete_button:

  140.       type: label

  141.       label: 'Delete flagging button text'

  142.     flag_update_button:

  143.       type: label

  144.       label: 'Update flagging button text'

  145.     form_behavior:

  146.       type: string

  147.       label: 'Where should the form open (new page, modal, etc)'

  148. 

  149. action.configuration.flag_action:*:

  150.   type: mapping

  151.   label: 'Configuration for flag actions'

  152.   mapping:

  153.     flag_id:

  154.       type: string

  155.       label: 'The flag ID'

  156.     flag_action:

  157.       type: string

  158.       label: 'Flag action (flag or unflag)'

  159. 

  160. action.configuration.flag_delete_flagging:

  161.   type: action_configuration_default

  162.   label: 'Delete flagging entities'