Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptionsForAddConnProps

Interface for options supplied to ConnectionPropsForSessCfg.addPropsOrPrompt()

export
interface

ISession

Hierarchy

  • IOptionsForAddConnProps

Index

Properties

Methods

Properties

Optional defaultTokenType

defaultTokenType: SessConstants.TOKEN_TYPE_CHOICES

Specifies the default token type if not provided on the command line. Some commands such as "auth login" do not have a "tokenType" command line option, but still need to specify a default token type. The default value is TOKEN_TYPE_JWT.

Optional doPrompting

doPrompting: boolean

Indicates that want to prompt for user name and password when no form of credentials are supplied. CLI programs typically want this to be true. A GUI app calling the API may do its own prompting in the GUI and would set this value to false. The default value is true.

Optional requestToken

requestToken: boolean

Indicates that we want to generate a token. When true, we use the user and password for the operation to obtain a token. This applies during a login command. Otherwise, you typically want this to be false. The default value is false.

Methods

Optional getValuesBack

  • getValuesBack(properties: string[]): {}

  • Specifies the functionality that external applications will use for prompting. Activate this function to get all the needed properties

    example

    const connectableSessCfg = await ConnectionPropsForSessCfg.addPropsOrPrompt( sessCfg, commandParameters.arguments, {getValuesBack: YourOwnFunction} );

    Parameters

    • properties: string[]

    Returns {}

    • [key: string]: any

Generated using TypeDoc