lowdefy/packages/docs/actions/Validate.yaml

# Copyright 2020-2021 Lowdefy, Inc

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#     http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

_ref:
  path: templates/actions.yaml.njk
  vars:
    pageId: Validate
    pageTitle: Validate
    filePath: actions/Validate.yaml
    types: |
      ```
      (void): void
      (blockId: string): void
      (blockIds: string[]): void
      ```
    description: |
      The `Validate` action is used to validate a users input, usually before information is inserted into a database using a request.
      It is used in conjunction with the `required` and `validate` fields on input blocks. If the validation fails, the `Validate`
      action will fail, and this will stop the execution of actions that are defined after it.

      The first time a `Validate` action is called, validation error are shown to the user. The `Reset` action resets this.

      Validate only validates the input blocks that are inside the context it is called from. Therefore, if you use two contexts
      to separate two forms, only the one form will be validated.

    params: |
      ###### void
      The `Validate` action validates all blocks in the `context ` if called without params.

      ###### string
      A blockId of the block to validate.

      ###### string[]
      An array of blockIds of the blocks to validate.

    examples: |
      ###### Validate all inputs in the context:
      ```yaml
      - id: validate
        type: Validate
      ```

      ###### Validate a single input:
      ```yaml
      - id: validate_one
        type: Validate
        params: my_text_input
      ```

      ###### Validate a list of inputs:
      ```yaml
      - id: validate_one
        type: Validate
        params:
          - my_text_input_1
          - my_text_input_2
      ```