en-US/Download-Files-TubesMedia-SearchAndDownloadFilesOnWebsite.psm1-Help.xml

<?xml version="1.0" encoding="utf-8" ?>
<helpItems xmlns="http://msh" schema="maml">
    <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
        <command:details>
            <command:name>Invoke-FileDownload</command:name>
            <maml:description>
                <maml:para>Invoke-FileDownload function finds a file on website to download.</maml:para>
 
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Invoke</command:verb>
            <command:noun>FileDownload</command:noun>
            <dev:version/>
        </command:details>
        <maml:description>
                <maml:para>Provide URL of the website and the filename which can be exact or with wildcards.</maml:para>
 
        </maml:description>
        <command:syntax>
            <command:syntaxItem parametersetname="__AllParameterSets">
                <maml:name>Invoke-FileDownload</maml:name>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1">
                    <maml:name>URL</maml:name>
                    <maml:description>
                        <maml:para>Provide website URL to search the file for download.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">uri</command:parameterValue>
                </command:parameter>
                <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2">
                    <maml:name>Filename</maml:name>
                    <maml:description>
                        <maml:para>Provide filename with wildcards to search to download like Setup*.exe</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Enter the path to download folder. Do not provide filename in path, to use alternative filename use -NewFileName switch.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>GetLink</maml:name>
                    <maml:description>
                        <maml:para>Only return the direct download link (if founded).</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>ListFoundedFiles</maml:name>
                    <maml:description>
                        <maml:para>Get a list of founded files similar to file that you search.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                    <maml:name>NewFileName</maml:name>
                    <maml:description>
                        <maml:para>Provide new filename (with extension) when downloading.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1">
                <maml:name>URL</maml:name>
                <maml:description>
                    <maml:para>Provide website URL to search the file for download.</maml:para>
                </maml:description>
                    <command:parameterValue required="true" variableLength="false">uri</command:parameterValue>
                <dev:type>
                    <maml:name>uri</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2">
                <maml:name>Filename</maml:name>
                <maml:description>
                    <maml:para>Provide filename with wildcards to search to download like Setup*.exe</maml:para>
                </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                <dev:type>
                    <maml:name>string</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>Path</maml:name>
                <maml:description>
                    <maml:para>Enter the path to download folder. Do not provide filename in path, to use alternative filename use -NewFileName switch.</maml:para>
                </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                <dev:type>
                    <maml:name>string</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>GetLink</maml:name>
                <maml:description>
                    <maml:para>Only return the direct download link (if founded).</maml:para>
                </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                <dev:type>
                    <maml:name>switch</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>ListFoundedFiles</maml:name>
                <maml:description>
                    <maml:para>Get a list of founded files similar to file that you search.</maml:para>
                </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                <dev:type>
                    <maml:name>switch</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="Named">
                <maml:name>NewFileName</maml:name>
                <maml:description>
                    <maml:para>Provide new filename (with extension) when downloading.</maml:para>
                </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                <dev:type>
                    <maml:name>string</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <maml:alertSet>
            <maml:title></maml:title>
            <maml:alert>
                <maml:para>by chixus &#169;2023. - CHXOFT</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Invoke-FileDownload -URL https://www.7-zip.org/ -Filename &#39;7z*-x64.exe&#39;</dev:code>
                <dev:remarks>
                    <maml:para></maml:para>
 
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
    <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">
        <command:details>
            <command:name>Invoke-MediaDownload</command:name>
            <maml:description>
                <maml:para>Invoke-VideoDownload function downloads video files from websites that have a protection of downloading.</maml:para>
 
            </maml:description>
            <maml:copyright>
                <maml:para></maml:para>
            </maml:copyright>
            <command:verb>Invoke</command:verb>
            <command:noun>MediaDownload</command:noun>
            <dev:version/>
        </command:details>
        <maml:description>
                <maml:para>Downloads video media file.</maml:para>
 
        </maml:description>
        <command:syntax>
            <command:syntaxItem parametersetname="__AllParameterSets">
                <maml:name>Invoke-MediaDownload</maml:name>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">
                    <maml:name>URL</maml:name>
                    <maml:description>
                        <maml:para>Put Youtube, Facebook or similar Tube link to download video media file.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">uri</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">
                    <maml:name>Path</maml:name>
                    <maml:description>
                        <maml:para>Path to download folder. Default is Video folder in User Documents.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">
                    <maml:name>AdditionalArguments</maml:name>
                    <maml:description>
                        <maml:para>Put additional arguments, use -help for more details.</maml:para>
                    </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4">
                    <maml:name>ytdlMethod</maml:name>
                    <maml:description>
                        <maml:para>Use youtube-dl method to download video file, must specify the filename with no exstension.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
                <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5">
                    <maml:name>Help</maml:name>
                    <maml:description>
                        <maml:para>Show help for download executable and additional parameters.</maml:para>
                    </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                </command:parameter>
            </command:syntaxItem>
        </command:syntax>
        <command:parameters>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="1">
                <maml:name>URL</maml:name>
                <maml:description>
                    <maml:para>Put Youtube, Facebook or similar Tube link to download video media file.</maml:para>
                </maml:description>
                    <command:parameterValue required="true" variableLength="false">uri</command:parameterValue>
                <dev:type>
                    <maml:name>uri</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="4">
                <maml:name>ytdlMethod</maml:name>
                <maml:description>
                    <maml:para>Use youtube-dl method to download video file, must specify the filename with no exstension.</maml:para>
                </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                <dev:type>
                    <maml:name>switch</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2">
                <maml:name>Path</maml:name>
                <maml:description>
                    <maml:para>Path to download folder. Default is Video folder in User Documents.</maml:para>
                </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                <dev:type>
                    <maml:name>string</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3">
                <maml:name>AdditionalArguments</maml:name>
                <maml:description>
                    <maml:para>Put additional arguments, use -help for more details.</maml:para>
                </maml:description>
                    <command:parameterValue required="true" variableLength="false">string</command:parameterValue>
                <dev:type>
                    <maml:name>string</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
            <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5">
                <maml:name>Help</maml:name>
                <maml:description>
                    <maml:para>Show help for download executable and additional parameters.</maml:para>
                </maml:description>
                    <command:parameterValue required="false" variableLength="false">switch</command:parameterValue>
                <dev:type>
                    <maml:name>switch</maml:name>
                    <maml:uri/>
                </dev:type>
                <dev:defaultValue></dev:defaultValue>
            </command:parameter>
        </command:parameters>
        <maml:alertSet>
            <maml:title></maml:title>
            <maml:alert>
                <maml:para>by chixus &#169;2023. - CHXOFT</maml:para>
            </maml:alert>
        </maml:alertSet>
        <command:examples>
            <command:example>
                <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
                <maml:introduction>
                    <maml:para></maml:para>
                </maml:introduction>
                <dev:code>PS C:\&gt; Invoke-VideoDownload -URL https://www.youtube.com/watch?v=HyF9bsxCMUk -Path C:\MyFolder\</dev:code>
                <dev:remarks>
                    <maml:para></maml:para>
 
                </dev:remarks>
            </command:example>
        </command:examples>
    </command:command>
</helpItems>