@zowe/imperative/lib/rest/src/session/doc/IOptionsForAddConnProps.d.ts

framework for building configurable CLIs

import { ISession, SessConstants } from "../../..";
import { IHandlerParameters } from "../../../../cmd";
import { AUTH_TYPE_CHOICES } from "../SessConstants";
import { IOverridePromptConnProps } from "./IOverridePromptConnProps";
import { IPropsToPromptFor } from "../doc/IPropsToPromptFor";
/**
 * Interface for options supplied to ConnectionPropsForSessCfg.addPropsOrPrompt()
 * @export
 * @interface ISession
 */
export interface IOptionsForAddConnProps<SessCfgType extends ISession = ISession> {
    /**
     * 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.
     */
    requestToken?: 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.
     */
    doPrompting?: boolean;
    /**
     * 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.
     */
    defaultTokenType?: SessConstants.TOKEN_TYPE_CHOICES;
    /**
     * Specifies a list of authentication properties, and what they should override.
     * If one of these properties is available on the session, do not prompt for the other property.
     */
    propertyOverrides?: IOverridePromptConnProps<SessCfgType>[];
    /**
     * Allows passing additional properties for which to prompt.
     * Used in cases of an incorrect or missing key passphrase.
     */
    propsToPromptFor?: IPropsToPromptFor<SessCfgType>[];
    /**
     * 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<ISession>(
     *           sessCfg, commandParameters.arguments, {getValuesBack: YourOwnFunction}
     *      );
     */
    getValuesBack?(properties: string[]): {
        [key: string]: any;
    };
    /**
     * Specifies full command parameter object if running in a CLI environment (versus) as
     * a Node.js SDK
     * @type {IHandlerParameters}
     * @memberof IOptionsForAddConnProps
     */
    parms?: IHandlerParameters;
    /**
     * Specifies the description of your service to be used in CLI prompt
     * messages. If undefined, the default value is "your service".
     */
    serviceDescription?: string;
    /**
     * Specifies if properties that the user was prompted for should be
     * automatically stored in profiles. Defaults to true when team config
     * exists.
     */
    autoStore?: boolean;
    /**
     * Specifies list of authentication types that are supported for your
     * service. Defaults to allow all authentication types.
     */
    supportedAuthTypes?: AUTH_TYPE_CHOICES[];
}
//# sourceMappingURL=IOptionsForAddConnProps.d.ts.map