API Reference
Class
CmdletSetPersona
Enables, configures, or disables narration personas.
Inheritance
- PSCmdlet
- CmdletSetPersona
Constructors
public CmdletSetPersona() #Methods
ProcessRecord() #Executes the persona configuration.
Inherited Methods
public PathInfo CurrentProviderLocation(String providerId) #Returns:
PathInfoInherited from PSCmdlet
Parameters
- providerId String
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
public Collection<String> GetResolvedProviderPathFromPSPath(String path, out ProviderInfo provider) #Returns:
Collection<String>Inherited from PSCmdlet
Parameters
- path String
- provider ProviderInfo
public override String GetResourceString(String baseName, String resourceId) #Returns:
StringInherited from Cmdlet
Parameters
- baseName String
- resourceId String
public String GetUnresolvedProviderPathFromPSPath(String path) #Returns:
StringInherited from PSCmdlet
Parameters
- path String
public Object GetVariableValue(String name, Object defaultValue) #Returns:
ObjectInherited from PSCmdlet
Parameters
- name String
public Boolean ShouldContinue(String query, String caption) #Returns:
BooleanInherited from Cmdlet
Parameters
- query String
- caption String
- hasSecurityImpact Boolean
- yesToAll Boolean
- noToAll Boolean
public Boolean ShouldProcess(String verboseDescription, String verboseWarning, String caption) #Returns:
BooleanInherited from Cmdlet
Parameters
- verboseDescription String
- verboseWarning String
- caption String
- shouldProcessReason ShouldProcessReason
public Void ThrowTerminatingError(ErrorRecord errorRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- errorRecord ErrorRecord
public Void WriteCommandDetail(String text) #Returns:
VoidInherited from Cmdlet
Parameters
- text String
public Void WriteError(ErrorRecord errorRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- errorRecord ErrorRecord
public Void WriteInformation(InformationRecord informationRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- messageData Object
- tags String[]
public Void WriteObject(Object sendToPipeline) #Returns:
VoidInherited from Cmdlet
Parameters
- sendToPipeline Object
- enumerateCollection Boolean
public Void WriteProgress(ProgressRecord progressRecord) #Returns:
VoidInherited from Cmdlet
Parameters
- progressRecord ProgressRecord
Properties
public PersonaKind Persona { get; set; } #Parameter(Mandatory = true, ParameterSetName = "Set")Persona style to use.
public SwitchParameter Live { get; set; } #Parameter(Mandatory = false, ParameterSetName = "Set")Enable live narration.
public SwitchParameter NarrateVerbose { get; set; } #Parameter(Mandatory = false, ParameterSetName = "Set")Include verbose narration.
public SwitchParameter Off { get; set; } #Parameter(Mandatory = true, ParameterSetName = "Off")Disable persona narration.
Inherited Properties
public PSEventManager Events { get; } #Inherited from PSCmdlet
public PSHost Host { get; } #Inherited from PSCmdlet
public CommandInvocationIntrinsics InvokeCommand { get; } #Inherited from PSCmdlet
public ProviderIntrinsics InvokeProvider { get; } #Inherited from PSCmdlet
public JobManager JobManager { get; } #Inherited from PSCmdlet
public JobRepository JobRepository { get; } #Inherited from PSCmdlet
public InvocationInfo MyInvocation { get; } #Inherited from PSCmdlet
public PagingParameters PagingParameters { get; } #Inherited from PSCmdlet
public String ParameterSetName { get; } #Inherited from PSCmdlet
public SessionState SessionState { get; } #Inherited from PSCmdlet
public ICommandRuntime CommandRuntime { get; set; } #Inherited from Cmdlet
public Boolean Stopping { get; } #Inherited from Cmdlet
public CommandOrigin CommandOrigin { get; } #Inherited from InternalCommand