Skip to main content

GetAvailableCommands method (NotesLLMRequest - LotusScript)

Returns an array of commands that are available for use with Domino IQ.

Defined in​

NotesLLMRequest

Syntax​

availCmds = llmreq.GetAvailableCommands(SERVER$[, suppressErrors ])

Parameters​

SERVER$

String. The Domino Server IQ name that is needed to send the request. If empty, the request will be routed to the Domino IQ server configured to service the command.

[,suppressErrors ]

Boolean. Optional. If True, suppress any internal Notes error handling, will not raise exception only return Empty array of strings.

Return value​

Array of strings

Usage​

If not pass in suppressErrors = True, raises an Error if availability of a request can not be determined due to lower-level failures.

If your agent uses this method on Notes Client, keep in mind that Notes Client will catch the command list until it is restarted. To ensure the method return up-to-date command list, you need to restart Notes Client after making any updates.

Example​

Sub Initialize
    On Error Resume Next
    Dim session As New NotesSession
    Dim llmreq As NotesLLMRequest
    Dim displayMsg As String
    Dim availCmds As Variant
    Set llmreq  = session.CreateLLMRequest()
    availCmds = llmreq.GetAvailableCommands(""DominoIQ server/Org"")
    
    REM If there are no commands, an array with an empty string will be returned.
    If (Not Isempty(availCmds) And Len(availCmds(0)) > 0) Then
        Forall cmd In availCmds
            displayMsg = displayMsg + cmd
            displayMsg = displayMsg + Chr(10)
        End Forall  
        Messagebox displayMsg, MB_OK, "Available Commands"
    Else
        displayMsg = "No commands available."   
        Messagebox(displayMsg)
    End If
End Sub