NAME
InvocationService
DESCRIPTION
METHODS
start_session
$actual_session_id = $obj->start_session($session_id)valid_session
$return = $obj->valid_session($session_id)list_files
$return_1, $return_2 = $obj->list_files($session_id, $cwd, $d)- Parameter and return types
-
$session_id is a string $cwd is a string $d is a string $return_1 is a reference to a list where each element is a directory $return_2 is a reference to a list where each element is a file directory is a reference to a hash where the following keys are defined: name has a value which is a string full_path has a value which is a string mod_date has a value which is a string file is a reference to a hash where the following keys are defined: name has a value which is a string full_path has a value which is a string mod_date has a value which is a string size has a value which is a string
- Description
remove_files
$obj->remove_files($session_id, $cwd, $filename)- Parameter and return types
-
$session_id is a string $cwd is a string $filename is a string
- Description
rename_file
$obj->rename_file($session_id, $cwd, $from, $to)- Parameter and return types
-
$session_id is a string $cwd is a string $from is a string $to is a string
- Description
copy
$obj->copy($session_id, $cwd, $from, $to)- Parameter and return types
-
$session_id is a string $cwd is a string $from is a string $to is a string
- Description
make_directory
$obj->make_directory($session_id, $cwd, $directory)- Parameter and return types
-
$session_id is a string $cwd is a string $directory is a string
- Description
remove_directory
$obj->remove_directory($session_id, $cwd, $directory)- Parameter and return types
-
$session_id is a string $cwd is a string $directory is a string
- Description
change_directory
$obj->change_directory($session_id, $cwd, $directory)- Parameter and return types
-
$session_id is a string $cwd is a string $directory is a string
- Description
put_file
$obj->put_file($session_id, $filename, $contents, $cwd)- Parameter and return types
-
$session_id is a string $filename is a string $contents is a string $cwd is a string
- Description
get_file
$contents = $obj->get_file($session_id, $filename, $cwd)- Parameter and return types
-
$session_id is a string $filename is a string $cwd is a string $contents is a string
- Description
run_pipeline
$output, $errors = $obj->run_pipeline($session_id, $pipeline, $input, $max_output_size, $cwd)- Parameter and return types
-
$session_id is a string $pipeline is a string $input is a reference to a list where each element is a string $max_output_size is an int $cwd is a string $output is a reference to a list where each element is a string $errors is a reference to a list where each element is a string
- Description
exit_session
$obj->exit_session($session_id)valid_commands
$return = $obj->valid_commands()- Parameter and return types
-
$return is a reference to a list where each element is a command_group_desc command_group_desc is a reference to a hash where the following keys are defined: name has a value which is a string title has a value which is a string items has a value which is a reference to a list where each element is a command_desc command_desc is a reference to a hash where the following keys are defined: cmd has a value which is a string link has a value which is a string
- Description
get_tutorial_text
$text, $prev, $next = $obj->get_tutorial_text($step)- Parameter and return types
-
$step is an int $text is a string $prev is an int $next is an int
- Description
TYPES
directory
- Definition
-
a reference to a hash where the following keys are defined: name has a value which is a string full_path has a value which is a string mod_date has a value which is a string
file
- Definition
-
a reference to a hash where the following keys are defined: name has a value which is a string full_path has a value which is a string mod_date has a value which is a string size has a value which is a string
command_desc
- Definition
-
a reference to a hash where the following keys are defined: cmd has a value which is a string link has a value which is a string
command_group_desc
- Definition
-
a reference to a hash where the following keys are defined: name has a value which is a string title has a value which is a string items has a value which is a reference to a list where each element is a command_desc