Interface IWebHelpManager

Web help manager API that handles launching of web help and generating it if necessary.

export
interface: IWebHelpManager

Hierarchy

IWebHelpManager

Implemented by

WebHelpManager

Index

Methods

Methods

openHelp

openHelp(inContext: string, cmdResponse: IHandlerResponseApi): void

- Defined in @zowe/imperative/packages/cmd/src/help/doc/IWebHelpManager.ts:33
Launch help page for specific group/command in browser.

memberof

IWebHelpManager

Parameters
- inContext: string
  
  Name of page for group/command to jump to
- cmdResponse: IHandlerResponseApi
  
  Command response object to use for output
Returns void

openRootHelp

openRootHelp(cmdResponse: IHandlerResponseApi): void

- Defined in @zowe/imperative/packages/cmd/src/help/doc/IWebHelpManager.ts:25
Launch root help page in browser.

memberof

IWebHelpManager

Parameters
- cmdResponse: IHandlerResponseApi
  
  Command response object to use for output
Returns void

Generated using TypeDoc