Interface IDocument

Namespace

JobFlow.Models.Documents

Assembly

JobFlow.Models.dll

Represents a document.

public interface IDocument : IConcurrentEntity

Inherited Members

IConcurrentEntity.ConcurrencyToken

Remarks

Note that the Data type (as returned by DataType) may not be the type definied in the corresponding FlowDefinition. This is due to the system attempting to limit the number deserialization steps that are taken during processing.

However, important instances where the IDocument represents the Flow's defined document data type include when executing the Flow's rule engine. Prior to executing the rules, the system will ensure the document is converted to the appropriate type. When defining a rule via JobFlowRule<D>, the matched document will be of type Document<T>.

Properties

CreatedDateTime

Date and time when the Document was created.

DateTime CreatedDateTime { get; }

Property Value

DateTime

Data

Document data.

dynamic Data { get; set; }

Property Value

dynamic

DataType

.Net Type of the Data object.

[JsonIgnore]
[JsonIgnore]
Type DataType { get; }

Property Value

Type

DocumentId

Primary key of the Document.

string DocumentId { get; }

Property Value

string

Type

Document type.

string Type { get; }

Property Value

string

UpdatedDateTime

Date and time when the Document was last updated.

DateTime UpdatedDateTime { get; }

Property Value

DateTime

Methods

GetDataAsJObject()

JObject GetDataAsJObject()

Returns

JObject