You are here

Home » API reference » Agreement 3.0.x

agreement.schema.yml in Agreement 3.0.x

Same filename and directory in other branches
  1. 8.2 config/schema/agreement.schema.yml
config/schema/agreement.schema.yml

File

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

  2.   type: config_entity

  3.   label: 'Agreement'

  4.   mapping:

  5.     id:

  6.       type: string

  7.       label: 'ID'

  8.     label:

  9.       type: label

  10.       label: 'Name'

  11.     path:

  12.       type: uri

  13.       label: 'Path'

  14.     settings:

  15.       type: agreement_settings

  16.       label: 'Settings'

  17.     agreement:

  18.       type: text

  19.       label: 'Agreement text'

  20.       translatable: true

  21. 

  22. agreement_settings:

  23.   type: mapping

  24.   label: 'Settings'

  25.   mapping:

  26.     frequency:

  27.       type: float

  28.       label: 'Frequency'

  29.     title:

  30.       type: label

  31.       label: 'Agreement Page Title'

  32.       translatable: true

  33.     checkbox:

  34.       type: label

  35.       label: 'Checkbox Text'

  36.       translatable: true

  37.     format:

  38.       type: string

  39.       label: 'Text format'

  40.     submit:

  41.       type: label

  42.       label: 'Submit Text'

  43.       translatable: true

  44.     success:

  45.       type: text

  46.       label: 'Success Message'

  47.       translatable: true

  48.     revoked:

  49.       type: text

  50.       label: 'Revoked Message'

  51.       translatable: true

  52.     failure:

  53.       type: text

  54.       label: 'Failure Message'

  55.       translatable: true

  56.     destination:

  57.       type: uri

  58.       label: 'Destination'

  59.     reset_date:

  60.       type: integer

  61.       label: 'Last Reset Date'

  62.     visibility:

  63.       type: mapping

  64.       label: 'Visibility'

  65.       mapping:

  66.         settings:

  67.           type: integer

  68.           label: 'Visibility Settings'

  69.         pages:

  70.           type: sequence

  71.           label: 'Pages'

  72.           sequence:

  73.             type: uri

  74.     recipient:

  75.       type: email

  76.       label: 'Recipient Email'

  77.       nullable: true

  78.     roles:

  79.       type: sequence

  80.       label: 'Roles'

  81.       sequence:

  82.         type: string