This repository has been archived by the owner on Nov 13, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 31
/
IOptionsForAddConnProps.ts
78 lines (69 loc) · 2.6 KB
/
IOptionsForAddConnProps.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
import { SessConstants } from "../../..";
import { IHandlerParameters } from "../../../../cmd";
/**
* Interface for options supplied to ConnectionPropsForSessCfg.addPropsOrPrompt()
* @export
* @interface ISession
*/
export interface IOptionsForAddConnProps {
/**
* 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 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;
}