You are here

Home » API reference » Private Message 8.2

private_message.schema.yml in Private Message 8.2

Same filename and directory in other branches
  1. 8 config/schema/private_message.schema.yml
config/schema/private_message.schema.yml

File

config/schema/private_message.schema.yml
View source 
  1. private_message.settings:

  2.   type: config_object

  3.   label: 'Global settings for the Private Message module'

  4.   mapping:

  5.     enable_notifications:

  6.       type: boolean

  7.       label: 'Whether the module should offer the option to send notifications'

  8.     notify_by_default:

  9.       type: boolean

  10.       label: 'Whether to send notifications by default. Users will be able to alter this behavior in their profiles'

  11.     notify_when_using:

  12.       type: string

  13.       label: 'Whether notifications should be sent while the user is on the private message page.'

  14.     number_of_seconds_considered_away:

  15.       type: integer

  16.       label: 'The number of seconds after a user has accessed a thread, after which they should be considered as not viewing the thread anymore'

  17.     hide_form_filter_tips:

  18.       type: boolean

  19.       label: 'Whether or not to hide the filter tips on the message form'

  20.     hide_recipient_field_when_prefilled:

  21.       type: boolean

  22.       label: 'Whether or not to hide the recipient field when a recipient is passed through the URL'

  23.     create_message_label:

  24.       type: label

  25.       label: 'The label of the action to create private message'

  26.     save_message_label:

  27.       type: label

  28.       label: 'The label of the button to send a new message.'

  29.     autofocus_enable:

  30.       type: boolean

  31.       label: 'Whether or not the message autofocus feature is enabled.'

  32.     keys_send:

  33.       type: string

  34.       label: 'The keys allowed to press to send directly the message.'

  35.     remove_css:

  36.       type: boolean

  37.       label: 'Whether or not to remove the default CSS styles'

  38. 

  39. field.formatter.settings.private_message_thread_member_formatter:

  40.   type: mapping

  41.   label: 'Private message thread members formatter settings'

  42.   mapping:

  43.     display_type:

  44.       type: string

  45.       label: 'Display type'

  46.     entity_display_mode:

  47.       type: string

  48.       label: 'Display Mode'

  49.     members_prefix:

  50.       type: string

  51.       label: 'Members list prefix'

  52. 

  53. field.formatter.settings.private_message_thread_message_formatter:

  54.   type: mapping

  55.   label: 'Private message thread message formatter settings'

  56.   mapping:

  57.     message_count:

  58.       type: integer

  59.       label: 'The number of messages to show on load'

  60.     ajax_previous_load_count:

  61.       type: integer

  62.       label: 'The number of messages to load when the load previous button is clicked'

  63.     message_order:

  64.       type: string

  65.       label: 'The order in which private messages should be shown, ascending or descending'

  66.     ajax_refresh_rate:

  67.       type: integer

  68.       label: 'The number of seconds between ajax checks for new messages'

  69.     view_mode:

  70.       type: string

  71.       label: 'The view mode used to render private messages'

  72. 

  73. field.widget.settings.private_message_thread_member_widget:

  74.   type: mapping

  75.   label: 'Private message thread member widget settings'

  76.   mapping:

  77.     match_operator:

  78.       type: string

  79.       label: 'Autocomplete matching'

  80.     match_limit:

  81.       type: integer

  82.       label: 'Maximum number of autocomplete suggestions.'

  83.     max_members:

  84.       type: integer

  85.       label: 'Maximum number of members that can be added.'

  86.     size:

  87.       type: integer

  88.       label: 'Size of textfield'

  89.     placeholder:

  90.       type: label

  91.       label: 'Placeholder'

  92. 

  93. block.settings.private_message_inbox_block:

  94.   type: block_settings

  95.   label: 'Settings for the private message inbox block'

  96.   mapping:

  97.     thread_count:

  98.       type: integer

  99.       label: 'Block thread load count'

  100.     ajax_load_count:

  101.       type: integer

  102.       label: 'Ajax thread load count'

  103.     ajax_refresh_rate:

  104.       type: integer

  105.       label: 'Ajax refresh rate'

  106. 

  107. block.settings.private_message_notification_block:

  108.   type: block_settings

  109.   label: 'Settings for the private message notifications block'

  110.   mapping:

  111.     ajax_refresh_rate:

  112.       type: integer

  113.       label: 'Ajax refresh rate'