Promise(T) Class

PromiseT Class

Supports all classes in the .NET Framework class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all classes in the .NET Framework; it is the root of the type hierarchy.

Inheritance Hierarchy

SystemObject
Innovator.ClientPromiseT

Namespace: Innovator.Client
Assembly: Innovator.Client (in Innovator.Client.dll) Version: 2016.1.15.1759 (2016.01.15.1759)

Syntax

Copy

public class Promise<T> : IPromise<T>, IPromise, 
	ICancelable

Public Class Promise(Of T)
	Implements IPromise(Of T), IPromise, ICancelable

Type Parameters

T

The PromiseT type exposes the following members.

Constructors

	Name	Description
	PromiseT	Initializes a new instance of the PromiseT class

Top

Properties

	Name	Description
	Invoker
	IsComplete	Indicates that the operation completed (either successfully or with an error)
	IsRejected	Whether an error occurred causing the promise to be rejected
	IsResolved	Whether the promise completed successfully
	PercentComplete	The progress of the promise represented as an integer from 0 to 100
	Value	The result of the promise. Only valid if IsResolved is true

Top

Methods

	Name	Description
	Always	Callback to be executed when the promise completes regardless of whether an error occurred
	Cancel	Cancel the operation
	CancelTargetC	Set the object to be canceled when the promise is canceled
	Done	Callback to be executed when the promise completes successfully
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	ExecuteCallbacks	Execute the stored callbacks for the given condition
	Fail	Callback to be executed when the promise encounters an error
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Notify	Notify promise listeners of a change in the progres
	Progress	Callback to be executed when the reported progress changes
	Reject	Mark the promise as having encountered an error
	Resolve	Mark the promise as having completed successfully providing the requested data
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	CancelledT	Attach a callback that runs when the promise is canceled (Defined by Promises.)
	ContinueT, S	Continue a promise chain by acting on the previous promise's result and returning a new promise (Defined by Promises.)
	ConvertT, S(FuncT, S)	Overloaded. Convert a promise using a simple transformation to go from one type to another (Defined by Promises.)
	ConvertT, S(ActionT, PromiseS, ActionException, PromiseS)	Overloaded. Convert a promise by modifying the done/fail logic in addition to transforming the type. (Defined by Promises.)
	ErrorT	Attach a callback that runs an error (other than a cancellation error) occurs (Defined by Promises.)
	FailOverT	(Defined by Promises.)
	ToTaskT	Convert a promise to a .Net 4.0 Task for use with the async/await keywords (Defined by Promises.)
	WaitT	Block the current thread waiting for a promise to complete (Defined by Promises.)
	WithInvokerT	Changes the invokation logic of the promise (e.g. to trigger invokation on the UI thread) (Defined by Promises.)

Top

Explicit Interface Implementations

	Name	Description
	IPromiseAlways	Callback to be executed when the promise completes regardless of whether an error occurred
	IPromiseDone	Callback to be executed when the promise completes successfully
	IPromiseFail	Callback to be executed when the promise encounters an error
	IPromiseProgress	Callback to be executed when the reported progress changes
	IPromiseValue	The result of the promise. Only valid if IsResolved is true

Top

Reference

Innovator.Client Namespace