Getting Started > Getting Help

To display all commands supported by the library, execute the following

Get-Module RayFlow

To display a help for a specific command, execute the following

Get-Help <CommandName>

For example, this gets the module info:

Get-Module RayFlow

ModuleType Version Name ExportedCommands

---------- ------- ---- ----------------

Binary 1.0.0.0 Raynet.RaySuite.Common.RayFlow.A... {ConvertTo-RayFlowEncryptedClientPas...

And the following lists all available commands:

(Get-Module RayFlow).ExportedCommands

Key Value
--- -----

ConvertTo-RayFlowEncryptedClientPassword ConvertTo-RayFlowEncryptedClientPassword

Publish-RayFlowOrder Publish-RayFlowOrder

New-RayFlowOrder New-RayFlowOrder

Get-RayFlowHistory Get-RayFlowHistory

Start-RayFlowFileUpload Start-RayFlowFileUpload

Start-RayFlowFileDownload Start-RayFlowFileDownload

Get-RayFlowCredentials Get-RayFlowCredentials

Get-RayFlowTask Get-RayFlowTask

Get-RayFlowPhase Get-RayFlowPhase

Get-RayFlowProject Get-RayFlowProject

Update-RayFlowTaskDataField Update-RayFlowTaskDataField

Add-RayFlowTaskComment Add-RayFlowTaskComment

Update-RayFlowTaskStatus Update-RayFlowTaskStatus

And to display help for a specific command (for example Get-RayFlowProject):

Get-Help Get-RayFlowProject -Full

NAME

Get-RayFlowProject

SYNTAX

Get-RayFlowProject [-RayFlowServerUrl] <string> [-Credentials] <pscredential> [[-ProjectId]

<guid>] [<CommonParameters>]