diff --git a/documentation/Functions.md b/documentation/Functions.md index d2c00d1e..48c96987 100644 --- a/documentation/Functions.md +++ b/documentation/Functions.md @@ -312,13 +312,26 @@ If the tutorial should be tested on the console environment, you have to specify *** ### downloadFile +This function is used to download a file from an external URL. #### parameter -1. URL of the file to be downloaded. -2. Name of file. -3. (Optional) Downloads file to a given directory relative to workspace. Directory is created, if its not existing. +This function consist of 3 parameters. +1. First parameter: + - **Required** + - **Type**- String + - **Description**- URL of the file to be downloaded. +2. Second Parameter: + - **Required** + - **Type**- String + - **Description**- Name of file +3. Third parameter: + - **Optional** + - **Type**- String + - **Description**- The path where the file should be stored. It can be used if you want to load the file into a different folder and not into the current Workspace. If folder does not exists, it will be created. #### example downloadFile("https://bit.ly/2BCkFa9", "file", "downloads") +Note: The command for execution will be generated by Katacoda runner, so user will have to execute this command manually. + *** ### buildNg @@ -433,4 +446,4 @@ addSetupScript("assets/createProjectScript.sh", "assets/createProjectScript.ps1" 1. Path of the file to be opened (relative path to the workspace directory) #### example -openFile("cobigenexample/core/src/main/java/com/example/application/cobigenexample/customermanagement/dataaccess/api/CustomerEntity.java") \ No newline at end of file +openFile("cobigenexample/core/src/main/java/com/example/application/cobigenexample/customermanagement/dataaccess/api/CustomerEntity.java")