Breeze.Sharp Namespace
Welcome to the Breeze.Sharp API documentation. If this is your first time browsing the API, you might want to start with the EntityManager as this is the core class in Breeze. Sample applications, videos, and additional documentation are also available. Ask questions in our community forum and get answers from support engineers, MVPs, and developers just like you. If you prefer to use email, please contact us at

  Class Description
Public class BackupValuesMap
Class that is used to track property changes on an Entity or ComplexObject. Instances of this type are used for both the EntityAspect.OriginalValuesMap as well as to track IEditableObject changes on an entity.
Public class BaseComplexObject
Default base class implementation of IComplexObject. All complex objects should inherit from this class either directly or indirectly.
Public class BaseEntity
Default base class implementation of IEntity. All entities should inherit from this class either directly or indirectly.
Public class CacheQueryOptions
Options that allow queries that will be run against cache to share the same semantics as the corresponding query against the Entity Framework and the backend database. Linq To Objects (CLR) and remote service queries do not automatically share the same semantics. This class allows Breeze queries against the EntityManager's cache (Linq to Objects queries) to be interpreted like they will be against the remote service.
Public class CamelCasePropertiesNamingConvention
The "camelCase" naming convention - This implementation only lowercases the first character of the server property name but leaves the rest of the property name intact. If a more complicated version is needed then another type should be created that inherits from NamingConvention.
Public class ComplexAspect
Provides entity services to a ComplexObject.
Public class ComplexType
Metadata information about a complex type.
Public class Configuration
A singleton class that provides basic registration mechanisms for a Breeze application.
Public class DataProperty
A DataProperty describes the metadata for a single property of an EntityType that contains simple data. Instances of the DataProperty class are constructed automatically during assembly probing and and then updated via Metadata retrieval from an entity server. Itt is also possible to update/extend them directly on the client.
Public class DataPropertyBuilder
Provides a fluent interface for configuring an DataProperty within the MetadataStore.
Public class DataService
A DataService instance is used to encapsulate the details of a single 'service'; this includes a serviceName, a dataService adapterInstance, and whether the service has server side metadata.
Public class DataServiceRequestException
Exception thrown when a DataService request fails. See the HttpResponse property for detailed information on the failed request.
Public class DataType
Metadata about any primitive data type. Each Breeze DataProperty for a primitive type (i.e. does not describe a ComplexObject) will have a DataType property.
Public class DefaultKeyGenerator
Default implementation of IKeyGenerator that automatically generates temporary ids for most common datatypes.
Public class DictionaryKeysAreNotPropertyNamesJsonConverter
Public class EmailValidator
Public class EntityAspect
Provides entity services to a IEntity.
Public class EntityChangedEventArgs
Provides information to the EntityChanged event.
Public class EntityChangeEventArgs
Base class for all Entity Changing/Changed event args.
Public class EntityChangingEventArgs
Provides information to the EntityChanging event.
Public class EntityError
Information about any errors encountered on a specific entity during the course of a EntityManager.SaveChanges operation. A collection of EntityError instances is part of every SaveException
Public class EntityKey
Represents the primary key for an IEntity.
Public class EntityManager
Instances of the EntityManager contain and manage collections of entities, either retrieved from a backend datastore or created on the client.
Public class EntityManagerEntityKeyFetchResult
The async result of a FetchEntityByKey call.
Public class EntityManagerCreatedEventArgs
Arguments to the EntityManagerCreated event.
Public class EntityManagerHasChangesChangedEventArgs
Arguments to the EntityManager's HasChangesChanged event.
Public class EntityQuery
Base class for all EntityQueries. This class is untyped and may be used when you need to create entity queries dynamically.
Public class EntityQueryT
An EntityQuery instance is used to query entities either from a remote datasource or from a local EntityManager. EntityQueries are immutable - this means that all EntityQuery methods that return an EntityQuery actually create a new EntityQuery. Therefore EntityQueries can be 'modified' without affecting any current instances.
Public class EntityQueryExtensions
Extension methods for any EntityQuery.
Public class EntityStateFns
Provides a set of static methods extending an IEntity to provide information about the EntityState.
Public class EntityType
Container for all of the metadata about a specific type of Entity.
Public class EntityTypeBuilderTEntity
Provides a fluent interface for configuring an EntityType within the MetadataStore.
Public class ImportOptions
Options that mediate how imported entities should be merged into an EntityManager.
Public class ImportResult
Information about the result of an EntityManager.ImportEntities operation.
Public class Int32RangeValidator
Public class Internable
Public class JNode
For internal use only. Wrapper over simple json object to provide serialization/deserialization services.
Public class JsonEntityConverter
For internal use only.
Public class JsonNodeInfo
This types describes the result of each VisitNode(JObject, MappingContext, NodeContext) operation.
Public class LocalizedMessage
Describes a localized message. Each localized message instance is immutable.
Public class MappingContext
Used by the JsonResultsAdapter to provide information regarding the overall context of the currently executing operation.
Public class MaxLengthValidator
Validator implementation that checks that a string does not exceed a maximum length.
Public class MetadataMismatchEventArgs
Public class MetadataStore
An instance of the MetadataStore contains all of the metadata about a collection of EntityTypes and ComplexTypes.
Public class NamingConvention
A NamingConvention instance is used to specify the naming conventions under which the MetadataStore will translate type and property names between the server and the .NET client. The default NamingConvention does not perform any translation, it simply passes property names thru unchanged.
Public class NavigationProperty
A NavigationProperty describes the metadata for a single property of an EntityType that return instances of other EntityTypes. Instances of the NavigationProperty class are constructed automatically during Metadata retrieval. However it is also possible to construct them directly via the constructor.
Public class NavigationPropertyBuilderTEntity, TTarget
Provides a fluent interface for configuring an NavigatiomProperty within the MetadataStore.
Public class NavigationSetT
Concrete strongly typed implementation of the INavigationSet interface. Used, by default, for as the return type for all nonscalar navigation properties.
Public class NodeContext
Used by the IJsonResultsAdapter to provide information about the current node being processed.
Public class NumericDataType
Subtype of DataType for all numeric datatypes.
Public class PhoneNumberValidator
Public class QueryOptions
A QueryOptions instance is used to specify the 'options' under which a query will occur.
Public class QueryResultT
The actual result of any query that has an InlineCount specified. This class also implement IEnumerable{T} for the actual returned entities. If you want the InlineCount for any query you will need to cast the return type from the query into a QueryResult{T}).
Public class RangeValidatorT
Validator implementation that checks that a number falls within a specified range..
Public class RegexValidator
Validator implementation that determines if a given property matches a predefined regular expression pattern.
Public class RequiredValidator
Validator implementation to check that a property is not set to null. Special handling for empty strings is supported.
Public class SaveException
SaveExceptions are thrown whenever an SaveChanges(SaveOptions) call fails for any reason.
Public class SaveOptions
A SaveOptions instance is used to specify the 'options' under which a save will occur.
Public class SaveResult
The result of an SaveChanges(SaveOptions) call
Public class SqlServerGuidComparer
A comparer that emulates SQL Server's comparison semantics for Guids.
Public class StringLengthValidator
Validator implementation that checks that a string's length is within a specified range.
Public class StructuralAspect
Base class for both EntityAspect and ComplexAspect.
Public class StructuralObjectExtensions
Extension methods for any IStructuralObject.
Public class StructuralProperty
Base class for both the DataProperty and the NavigationProperty classes.
Public class StructuralType
Base class for both EntityType and ComplexType classes.
Public class StructuralTypeBuilder
Base class that provides a fluent interface for configuring the MetadataStore.
Public class TimeSpanConverter
Public class TypeNameInfo
Class used to describe, parse and convert between EntityType/ComplexType names and CLR type names.
Public class UniqueId
Represents the combination of a specific StructuralProperty and value.
Public class UniqueIdCollection
Represents a collection of UniqueId objects.
Public class UniqueIdMap
A strongly typed dictionary mapping UniqueId keys containing temporary identifiers to values for the permanent identifiers.
Public class UrlValidator
Public class ValidationContext
The context under which a validation operation will occur. This includes the Entity or ComplexObject being validated, as well as the specific property, if this is a property validation.
Public class ValidationError
The result of a failed validation operation
Public class ValidationErrorCollection
A collection of ValidationErrors.
Public class ValidationOptions
A ValidationOptions instance is used to specify the conditions under which validation will be executed. This may be set via the ValidationOptions property.
Public class Validator
Subclassed instances of the Validator class provide the logic to validate another object and provide a description of any errors encountered during the validation process. They are typically associated with a 'validators' property on the following types: EntityType, DataProperty or NavigationProperty. A number of property level validators are registered automatically, i.e added to each DataProperty.Validators property based on DataProperty metadata. For example, DataProperty.MaxLength -> MaxLengthValidator DataProperty.IsNullable -> RequiredValidator (if not nullable)
Public class ValidatorExtensions
Collection of extension methods for use with any .
Public class WebApiDataServiceAdapter
IDataServiceAdapter implementation that supports Microsoft's WebApi.
Public class WebApiJsonResultsAdapter

  Interface Description
Public interface IComplexObject
Interface that describes a ComplexObject
Public interface IDataServiceAdapter
Client side interface that describes the interaction between a DataService and a remote data service.
Public interface IEntity
Interface that describes an Entity.
Public interface IEntityQuery
Interface for all Entity queries.
Public interface IHasBackingStore
Interface for the backing information for any IEntity or IComplexObject. Implemented via an explicit interface.
Public interface IHasInlineCount
Public interface IJsonResultsAdapter
Instances of this interface are used to provide custom extraction and parsing logic on the json results returned by any web service. This facility makes it possible for breeze to talk to virtually any web service and return objects that will be first class 'breeze' citizens.
Public interface IJsonSerializable
For internal use only.
Public interface IKeyGenerator
Interface that generates, describes and keeps track of all of the temporary keys associated with a single EntityManager.
Public interface INavigationSet
The interface that describes the type for any nonscalar navigation property on an Entity.
Public interface IStructuralObject
Interface implemented by by IEntity and IComplexObject.

  Enumeration Description
Public enumeration AutoGeneratedKeyType
AutoGeneratedKeyType is an enum containing all of the valid states for an automatically generated key.
Public enumeration ConcurrencyMode
Public enumeration DataTypeInfo
Used to classify whether a data type is a number, an integer or a date.
Public enumeration EntityAction
Describes an action performed on an Entity.
Public enumeration EntityState
The state of an IEntity.
Public enumeration EntityVersion
Describes the version of an Entity.
Public enumeration FetchStrategy
An enum used when retrieving entities to determine where to look
Public enumeration GuidOrdering
Different semantics for ordering Guids.
Public enumeration LoadingOperation
Enum that is used to describe the current operation being performed while a JsonResultsAdapter is executing. Referenced by MappingContext
Public enumeration MergeStrategy
Strategy to control how Entities are merged into an EntityManager's cache.
Public enumeration MessageType
Public enumeration MetadataMismatchType
Public enumeration UrlOptions
Public enumeration ValidationApplicability
An enum used to describe the conditions under which validation should occur. This value is set via the ValidationApplicability.