PropertySet class

Represents a set of item or folder properties. Property sets are used to indicate what properties of an item or folder should be loaded when binding to an existing item or folder or when loading an item or folder's properties.
Implemented types
Mixed-in types

Constructors

PropertySet(BasePropertySet basePropertySet, Iterable<PropertyDefinitionBase>? additionalProperties)
Initializes a new instance of PropertySet.
PropertySet.fromPropertyDefinitions(List<PropertyDefinitionBase> additionalProperties)
Initializes a new instance of PropertySet based upon BasePropertySet.IdOnly.
PropertySet.fromPropertySet(BasePropertySet basePropertySet)
Initializes a new instance of PropertySet.
PropertySet.idOnly()
Initializes a new instance of PropertySet based upon BasePropertySet.IdOnly.

Properties

Gets or sets value indicating whether or not to add blank target attribute to anchor links.
getter/setter pair
BasePropertySet BasePropertySet?
Gets or sets the base property set the property set is based upon.
getter/setter pair
BlockExternalImages bool?
Gets or sets value indicating whether or not to convert inline images to data URLs.
getter/setter pair
ConvertHtmlCodePageToUTF8 bool?
Gets or sets value indicating whether or not to convert HTML code page to UTF8 encoding.
getter/setter pair
Count int
Gets the number of explicitly added properties in this set.
no setter
FilterHtmlContent bool?
Gets or sets value indicating whether or not to filter potentially unsafe HTML content from message bodies.
getter/setter pair
first PropertyDefinitionBase
The first element.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
InlineImageUrlTemplate String?
Gets or sets a value of the URL template to use for the src attribute of inline IMG elements.
getter/setter pair
isEmpty bool
Whether this collection has no elements.
no setterinherited
isNotEmpty bool
Whether this collection has at least one element.
no setterinherited
iterator Iterator<PropertyDefinitionBase>
A new Iterator that allows iterating the elements of this Iterable.
no setteroverride
last PropertyDefinitionBase
The last element.
no setterinherited
length int
The number of elements in this Iterable.
no setterinherited
MaximumBodySize int?
Gets or sets the maximum size of the body to be retrieved.
getter/setter pair
RequestedBodyType BodyType?
Gets or sets type of body that should be loaded on items. If RequestedBodyType is null, body is returned as HTML if available, plain text otherwise.
getter/setter pair
RequestedNormalizedBodyType BodyType?
Gets or sets type of normalized body that should be loaded on items. If null, the should return the same value as body type.
getter/setter pair
RequestedUniqueBodyType BodyType?
Gets or sets type of body that should be loaded on items. If null, the should return the same value as body type.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
single PropertyDefinitionBase
Checks that this iterable has only one element, and returns that element.
no setterinherited

Methods

Add(PropertyDefinitionBase property) → void
Implements an implicit conversion between PropertySet and BasePropertySet.
AddRange(Iterable<PropertyDefinitionBase> properties) → void
Adds the specified properties to the property set.
any(bool test(PropertyDefinitionBase element)) bool
Checks whether any element of this iterable satisfies test.
inherited
cast<R>() Iterable<R>
A view of this iterable as an iterable of R instances.
inherited
Clear() → void
Remove all explicitly added properties from the property set.
Contains(PropertyDefinitionBase property) bool
contains(Object? element) bool
Whether the collection contains an element equal to element.
inherited
elementAt(int index) PropertyDefinitionBase
Returns the indexth element.
inherited
every(bool test(PropertyDefinitionBase element)) bool
Checks whether every element of this iterable satisfies test.
inherited
expand<T>(Iterable<T> toElements(PropertyDefinitionBase element)) Iterable<T>
Expands each element of this Iterable into zero or more elements.
inherited
firstWhere(bool test(PropertyDefinitionBase element), {PropertyDefinitionBase orElse()?}) PropertyDefinitionBase
The first element that satisfies the given predicate test.
inherited
fold<T>(T initialValue, T combine(T previousValue, PropertyDefinitionBase element)) → T
Reduces a collection to a single value by iteratively combining each element of the collection with an existing value
inherited
followedBy(Iterable<PropertyDefinitionBase> other) Iterable<PropertyDefinitionBase>
Creates the lazy concatenation of this iterable and other.
inherited
forEach(void action(PropertyDefinitionBase element)) → void
Invokes action on each element of this iterable in iteration order.
inherited
InternalValidate() → void
Validates this property set.
join([String separator = ""]) String
Converts each element to a String and concatenates the strings.
inherited
lastWhere(bool test(PropertyDefinitionBase element), {PropertyDefinitionBase orElse()?}) PropertyDefinitionBase
The last element that satisfies the given predicate test.
inherited
map<T>(T toElement(PropertyDefinitionBase e)) Iterable<T>
The current elements of this iterable modified by toElement.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reduce(PropertyDefinitionBase combine(PropertyDefinitionBase value, PropertyDefinitionBase element)) PropertyDefinitionBase
Reduces a collection to a single value by iteratively combining elements of the collection using the provided function.
inherited
Remove(PropertyDefinitionBase property) bool
Removes the specified property from the set.
singleWhere(bool test(PropertyDefinitionBase element), {PropertyDefinitionBase orElse()?}) PropertyDefinitionBase
The single element that satisfies test.
inherited
skip(int count) Iterable<PropertyDefinitionBase>
Creates an Iterable that provides all but the first count elements.
inherited
skipWhile(bool test(PropertyDefinitionBase value)) Iterable<PropertyDefinitionBase>
Creates an Iterable that skips leading elements while test is satisfied.
inherited
take(int count) Iterable<PropertyDefinitionBase>
Creates a lazy iterable of the count first elements of this iterable.
inherited
takeWhile(bool test(PropertyDefinitionBase value)) Iterable<PropertyDefinitionBase>
Creates a lazy iterable of the leading elements satisfying test.
inherited
toList({bool growable = true}) List<PropertyDefinitionBase>
Creates a List containing the elements of this Iterable.
inherited
toSet() Set<PropertyDefinitionBase>
Creates a Set containing the same elements as this iterable.
inherited
toString() String
Returns a string representation of (some of) the elements of this.
inherited
Validate() → void
Implements ISelfValidate.Validate. Validates this property set.
override
ValidateForRequest(ServiceRequestBase request, bool summaryPropertiesOnly) → void
Validates this property set instance for request to ensure that: 1. Properties are valid for the request server version. 2. If only summary properties are legal for this request (e.g. FindItem) then only summary properties were specified.
where(bool test(PropertyDefinitionBase element)) Iterable<PropertyDefinitionBase>
Creates a new lazy Iterable with all elements that satisfy the predicate test.
inherited
whereType<T>() Iterable<T>
Creates a new lazy Iterable with all elements that have type T.
inherited
WriteToXml(EwsServiceXmlWriter writer, ServiceObjectType? serviceObjectType) → void
Writes the property set to XML.

Operators

operator ==(Object other) bool
The equality operator.
inherited
operator [](int index) PropertyDefinitionBase
Gets the

Static Properties

DefaultPropertySetMap LazyMember<Map<BasePropertySet, String>>
Maps BasePropertySet values to EWS's BaseShape values.
no setter
FirstClassProperties PropertySet
Returns a predefined property set that includes the first class properties of an item or folder.
getter/setter pair
IdOnly PropertySet
Returns a predefined property set that only includes the Id property.
getter/setter pair

Static Methods

WriteAdditionalPropertiesToXml(EwsServiceXmlWriter writer, Iterable<PropertyDefinitionBase> propertyDefinitions) → void
Writes additonal properties to XML.