API Reference
Class
SecretPrompt
A secret (password, token): masked or hidden while typed, with Ctrl+R to reveal it for a moment, required by default. The answer never appears in summaries, logs or presets.
Inheritance
- Prompt<String>
- SecretPrompt
Constructors
public SecretPrompt(String title) #Creates a secret prompt.
Parameters
- title System.String
- The question.
Methods
public override String Describe(String value) #Returns:
StringThe answer as text, for the summary line left in the scrollback.
Parameters
- value System.String
- The answer.
Returns
The text.
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
public String Show(InteractiveOptions? options = null, CancellationToken cancellationToken = default) #Returns:
StringInherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Parameters
- options InteractiveOptions? = null
- cancellationToken CancellationToken = default
public Task<String> ShowAsync(InteractiveOptions? options = null, CancellationToken cancellationToken = default) #Returns:
Task<String>Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Parameters
- options InteractiveOptions? = null
- cancellationToken CancellationToken = default
public Boolean TryShow(out String value, InteractiveOptions? options = null, CancellationToken cancellationToken = default) #Returns:
BooleanInherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Parameters
- value String
- options InteractiveOptions? = null
- cancellationToken CancellationToken = default
Properties
Inherited Properties
public String Title { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
public String? Description { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
public String? ParameterName { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
public Boolean HasDefault { get; } #Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
public String Default { get; set; } #Inherited from 0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]