PSActivity Members

Represents the base class for Windows PowerShell workflow activities. Introduced in Windows PowerShell 3.0.

The following tables list the members exposed by the PSActivity type.

  Name Description
  PSActivity Initializes a new instance of the PSActivity class. Introduced in Windows PowerShell 3.0.
Top

  Name Description
public field static PSBookmarkPrefix Specifies the bookmark prefix for the Windows PowerShell workflow activity. This field is read-only. Introduced in Windows PowerShell 3.0.
public field static PSPersistBookmarkPrefix Specifies the bookmark prefix for persisted Windows PowerShell workflow activities. This field is read-only. Introduced in Windows PowerShell 3.0.
public field static PSSuspendBookmarkPrefix Specifies the bookmark prefix for suspended Windows PowerShell workflow activities. This field is read-only. Introduced in Windows PowerShell 3.0.
Top

(see also Protected Properties)
 NameDescription
public propertyAppendOutput  Determines whether to append output to the stream specified by the Result property. Introduced in Windows PowerShell 3.0. (Inherited from PipelineEnabledActivity)
public propertyDebugGets or sets a value that indicates whether to emit the debug output of the activity. Introduced in Windows PowerShell 3.0.
public propertyDisplayName  (Inherited from Activity)
public propertyErrorActionGets or sets how errors are handled by the activity. Introduced in Windows PowerShell 3.0.
public propertyId  (Inherited from Activity)
public propertyInput  The input stream for the activity. Introduced in Windows PowerShell 3.0. (Inherited from PipelineEnabledActivity)
public propertyMergeErrorToOutputGets or sets a value that indicates whether to merge error data to the output stream. Introduced in Windows PowerShell 3.0.
public propertyPSActionRetryCountGets or sets the number of times the activity retries execution of an action after encountering an execution error. Introduced in Windows PowerShell 3.0.
public propertyPSActionRetryIntervalSecGets or sets the number of seconds to wait before retrying the action. Introduced in Windows PowerShell 3.0.
public propertyPSActionRunningTimeoutSecGets or sets the number of seconds to wait before the action times out. Introduced in Windows PowerShell 3.0.
public propertyPSCommandNameGets the fully qualified name of the command invoked by this activity. Introduced in Windows PowerShell 3.0.
public propertyPSDebugGets or sets the debug stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.
public propertyPSDisableSerializationGets or sets a value that indicates whether to disable serialization for the activity. Introduced in Windows PowerShell 3.0.
public propertyPSErrorGets or sets the error stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.
public propertyPSPersistGets or sets a value that indicates whether to force the activity to persist the workflow state onto the disk. Introduced in Windows PowerShell 3.0.
public propertyPSProgressGets or sets the progress stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.
public propertyPSProgressMessageGets or sets the message in the progress stream. Introduced in Windows PowerShell 3.0.
public propertyPSRequiredModulesGets or sets the list of module names or paths that are required to run this activity successfully. Introduced in Windows PowerShell 3.0.
public propertyPSVerboseGets or sets the verbose stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.
public propertyPSWarningGets or sets the warning stream (or collection of streams) for the activity. Introduced in Windows PowerShell 3.0.
public propertyResult  The output stream from the activity. Introduced in Windows PowerShell 3.0. (Inherited from PipelineEnabledActivity)
public propertyUseDefaultInput  Specifies whether to connect the input stream for this activity. Introduced in Windows PowerShell 3.0. (Inherited from PipelineEnabledActivity)
public propertyVerboseGets or sets a value that indicates whether to emit verbose output of the activity. Introduced in Windows PowerShell 3.0.
public propertyWarningActionGets or sets how warnings are handled by the activity. Introduced in Windows PowerShell 3.0.
Top

  Name Description
protected property CanInduceIdle Overridden. Gets a value that indicates whether the activity can be idle. Introduced in Windows PowerShell 3.0.
protected property Constraints  (Inherited from Activity)
protected property DefiningModule Gets the name of the module that an activity needs to load before it can execute. Introduced in Windows PowerShell 3.0.
protected property Implementation  Overridden. (Inherited from Activity)
protected property ParameterDefaults Gets or sets the parameter defaults. Introduced in Windows PowerShell 3.0.
protected property PSDefiningModule Gets the module that defines the command called by this activity. Introduced in Windows PowerShell 3.0.
protected property Tracer Gets access to Windows PowerShell tracing channels. Introduced in Windows PowerShell 3.0.
protected property UpdatePreferenceVariable Gets a value that indicates whether preference variables are updated. Introduced in Windows PowerShell 3.0.
Top

(see also Protected Methods)
 NameDescription
public methodEquals  (Inherited from Object)
public methodGetHashCode  (Inherited from Object)
public methodGetType  (Inherited from Object)
public methodShouldSerializeDisplayName  (Inherited from Activity)
public methodToString  Overridden. (Inherited from Object)
Top

(see also Extension Methods)
 NameDescription
protected methodAbort  (Inherited from NativeActivity)
protected methodActivityEndPersistenceWhen overridden in a derived class, ends the persistence of the Windows PowerShell activity. Introduced in Windows PowerShell 3.0.
protected methodCacheMetadataOverridden. Retrieves the stream and ubiquitous parameter information from the hosting application. Introduced in Windows PowerShell 3.0.
protected methodCacheMetadata  Overridden. (Inherited from Activity)
protected methodCancelOverridden. Cancels the running activity. Introduced in Windows PowerShell 3.0.
protected methodExecuteOverridden. Begins the execution of the activity. Introduced in Windows PowerShell 3.0.
protected methodFinalize  (Inherited from Object)
protected methodGetActivityArgumentsRetrieves the list of arguments for the activity. Introduced in Windows PowerShell 3.0.
protected methodGetImplementationWhen overridden in a derived class, implements any functionality that is specific to a command type. Introduced in Windows PowerShell 3.0.
protected methodGetPowerShellWhen overridden in a derived class, retrieves a configured instance of PowerShell. Introduced in Windows PowerShell 3.0.
protected methodGetRunInProcDetermines whether this activity should be run in or out of process when run locally. Introduced in Windows PowerShell 3.0.
protected methodMemberwiseClone  (Inherited from Object)
protected methodOnCreateDynamicUpdateMap  (Inherited from NativeActivity)
protected methodOnCreateDynamicUpdateMap  Overridden. (Inherited from Activity)
protected methodPrepareSessionWhen overridden in a derived class, customizes the runspace of a PowerShell instance that the runtime has prepared for it. Introduced in Windows PowerShell 3.0.
protected methodUpdateInstance  (Inherited from NativeActivity)
protected methodWriteProgressRecordWrites a progress record for the current activity. Introduced in Windows PowerShell 3.0.
Top

  Name Description
public extension method As  Use this method to adapt an object from a foreign app domain to a known interface in this app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method As  This is called to adapt an object from a foreign app domain to a known interface in this appDomainThis element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method As  Adapts an object from a foreign app domain to a known interface in this app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method Extend  Use this method to adapt and extend an object so that you can pass it to a foreign app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method Extend  This is called to adapt and extend an object that we wish to pass to a foreign app domainThis element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method Extend  Used to extend an object with an interface from a foreign app domain.This element is introduced in Windows PowerShell 5.0. (Defined by RequestExtensions.)
public extension method ToEnumerable  This element is introduced in Windows PowerShell 5.0. (Defined by CollectionExtensions.)
Top


Show: