You are here

Home » API reference » Apply for role 8

apply_for_role.schema.yml in Apply for role 8

src/config/schema/apply_for_role.schema.yml

File

src/config/schema/apply_for_role.schema.yml
View source 
  1. apply_for_role.settings:

  2.   type: config_object

  3.   label: 'Apply for Role configuration'

  4.   mapping:

  5.     multiple_roles_per_app:

  6.       type: boolean

  7.       label: 'Allow a user to select multiple roles on application form.'

  8. 

  9.     #Not boolean because choices are either no(0), optional(1) or yes(2)

  10.     apply_for_role_on_registration_form:

  11.     #boolean?

  12.       type: integer

  13.       label: 'Placement of apply for role on registration form.'

  14. 

  15.     # @TODO: Determine just what this does and update label if incorrect.

  16.     display_approved_roles_app_form:

  17.       type: boolean

  18.       label: 'Displaying of the approved roles app form'

  19. 

  20.     allow_user_message_with_app:

  21.       type: boolean

  22.       label: 'Allow the user to submit a message with their application.'

  23. 

  24.     #figure out how to store multiple roles? See OS training!

  25.     apply_for_role_roles:

  26.       type: sequence

  27.       label: 'List of roles that a user can apply for with apply for role.'

  28. 

  29.     user_apply_form_description:

  30.       type: string

  31.       label: 'User application form description field.'

  32. 

  33.     send_email_to_admin:

  34.       type: boolean

  35.       label: 'Send an email to the admin(s) on role application.'

  36. 

  37.     admin_email_addresses:

  38.       type: string

  39.       label: 'comma seperated list of emails -OR- blank to send to UID 1'

  40. 

  41.     admin_email_subject:

  42.       type: string

  43.       label: 'Subject of email going to administrator(s)'

  44. 

  45.     admin_email_body:

  46.       type: string

  47.       label: 'Body of email going to administrator(s)'

  48. 

  49.     send_user_approval_email:

  50.       type: boolean

  51.       label: 'Send an email to the user upon role application approval.'

  52. 

  53.     send_user_approval_subject:

  54.       type: string

  55.       label: 'Subject line of email to users upon role application approval'

  56. 

  57.     send_user_approval_body:

  58.       type: string

  59.       label: 'body of email to users upon role application approval'

  60. 

  61.     send_user_deny_email:

  62.       type: boolean

  63.       label: 'Send users a denial email if application is denied.'

  64. 

  65.     send_user_deny_subject:

  66.       type: string

  67.       label: 'User application denial email subject line.'

  68. 

  69.     send_user_deny_body:

  70.       type: string

  71.       label: 'User application denial email body.'