Contact class

Represents a contact. Properties available on contacts are defined in the ContactSchema class.

Inheritance

• Object
• ServiceObject
• Item
• Contact

Constructors

Contact(ExchangeService service)

Initializes an unsaved local instance of

Contact.withAttachment(ItemAttachment parentAttachment)

Initializes a new instance of the

Properties

Alias → String?

Gets the Alias from the directory

no setter

AssistantName ↔ String?

Gets or sets the contact's assistant name.

getter/setter pair

Attachments → AttachmentCollection

Gets a list of the attachments to this item.

no setter, inherited

Birthday ↔ DateTime?

Gets or sets the birthday of the contact.

getter/setter pair

Body ↔ MessageBody?

Gets or sets the body of this item.

getter/setter pair, inherited

BusinessHomePage ↔ String?

Gets or sets the business home page of the contact.

getter/setter pair

Categories ↔ StringList

Gets or sets the list of categories associated with this item.

getter/setter pair, inherited

Children ↔ StringList

Gets or sets a list of children for the contact.

getter/setter pair

Companies ↔ StringList

Gets or sets a list of companies for the contact.

getter/setter pair

CompanyName ↔ String?

Gets or sets the compnay name of the contact.

getter/setter pair

CompleteName → CompleteName?

Gets the complete name of the contact.

no setter

ContactSource → ContactSource?

Gets the source of the contact.

no setter

DateTimeCreated → DateTime?

Gets the date and time this item was created.

no setter, inherited

DateTimeReceived → DateTime?

Gets the time when this item was received.

no setter, inherited

DateTimeSent → DateTime?

Gets a list of Internet headers for this item.

no setter, inherited

DefaultAffectedTaskOccurrences → AffectedTaskOccurrence?

Gets the icon index.

no setter, inherited

DefaultSendCancellationsMode → SendCancellationsMode?

Gets the default setting for sending cancellations on Delete. Subclasses will override this for different default behavior.

no setter, inherited

DefaultSendInvitationsMode → SendInvitationsMode?

Gets the default settings for sending invitations on Save. Subclasses will override this for different default behavior.

no setter, inherited

DefaultSendInvitationsOrCancellationsMode → SendInvitationsOrCancellationsMode?

Gets the default settings for sending invitations or cancellations on Update. Subclasses will override this for different default behavior.

no setter, inherited

Department ↔ String?

Gets or sets the department of the contact.

getter/setter pair

DirectoryId → String?

Gets the User SMIME certificate from the directory

no setter

DirectoryPhoto → Uint8List?

Gets the Photo from the directory

no setter

DirectReports → EmailAddressCollection?

Get the direct reports mailbox information

no setter

DisplayName ↔ String?

Gets or sets the display name of the contact.

getter/setter pair

EffectiveRights → Set<EffectiveRights>?

Gets a value indicating the effective rights the current authenticated user has on this item.

no setter, inherited

EmailAddresses → EmailAddressDictionary

Gets an indexed list of e-mail addresses for the contact. For example, to set the first e-mail address, use the following syntax: EmailAddresses[EmailAddressKey.EmailAddress1] = "[e-mail]"

no setter

ExtendedProperties → ExtendedPropertyCollection

Gets a list of extended properties defined on this item.

no setter, inherited

FileAs ↔ String?

Gets or set the name under which this contact is filed as. FileAs can be manually set or can be automatically calculated based on the value of the FileAsMapping property.

getter/setter pair

FileAsMapping ↔ FileAsMapping?

Gets or sets a value indicating how the FileAs property should be automatically calculated.

getter/setter pair

Generation ↔ String?

Gets or sets the generation of the contact.

getter/setter pair

GivenName ↔ String?

Gets or sets the given name of the contact.

getter/setter pair

HasAttachments → bool?

Gets or sets the number of minutes before the start of this item when the reminder should be triggered.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

HasPicture → bool?

Gets a value indicating whether this contact has a picture associated with it.

no setter

ICalUid → String?

no setter, inherited

Id → ItemId?

Gets the Id of this item.

no setter, inherited

ImAddresses → ImAddressDictionary

Gets an indexed list of Instant Messaging addresses for the contact. For example, to set the first IM address, use the following syntax: ImAddresses[ImAddressKey.ImAddress1] = "[e-mail]"

no setter

Importance ↔ Importance?

Gets or sets the culture associated with this item.

getter/setter pair, inherited

Initials ↔ String?

Gets or sets the initials of the contact.

getter/setter pair

InstanceKey → Uint8List?

Gets the item instance key.

no setter, inherited

IsAssociated → bool?

Gets a value indicating whether this is an associated item.

no setter, inherited

IsAttachment → bool

Gets a value indicating whether the item is an attachment.

no setter, inherited

IsDirty → bool

Gets a value indicating whether the object has been modified and should be saved.

no setter, inherited

IsDraft → bool?

Gets a value indicating whether the item is is a draft. An item is a draft when it has not yet been sent.

no setter, inherited

IsFromMe → bool?

Gets a value indicating whether the item has been sent by the current authenticated user.

no setter, inherited

IsNew → bool

Gets a value indicating whether this object is a real store item, or if it's a local object that has yet to be saved.

no setter, inherited

IsReminderSet ↔ bool?

Gets or sets a value indicating whether a reminder is set for this item.

getter/setter pair, inherited

IsResend → bool?

Gets a value indicating whether the item is a resend of another item.

no setter, inherited

IsSubmitted → bool?

Gets or sets the In-Reply-To reference of this item.

no setter, inherited

IsUnmodified → bool?

Gets a value indicating whether the item has been modified since it was created.

no setter, inherited

ItemClass ↔ String?

Gets or sets the custom class name of this item.

getter/setter pair, inherited

JobTitle ↔ String?

Gets or sets the contact's job title.

getter/setter pair

LastModifiedName → String?

Gets the name of the user who last modified this item.

no setter, inherited

LastModifiedTime → DateTime?

Gets the date and time this item was last modified.

no setter, inherited

Manager ↔ String?

Gets or sets the name of the contact's manager.

getter/setter pair

ManagerMailbox → EmailAddress?

Gets the manager mailbox information

no setter

MiddleName ↔ String?

Gets or sets the initials of the contact.

getter/setter pair

Mileage ↔ String?

Gets or sets the mileage for the contact.

getter/setter pair

MimeContent ↔ MimeContent?

Get or sets the MIME content of this item.

getter/setter pair, inherited

NickName ↔ String?

Gets or sets the middle name of the contact.

getter/setter pair

Notes → String?

Get the Notes from the directory

no setter

OfficeLocation ↔ String?

Gets or sets the location of the contact's office.

getter/setter pair

onChange ↔ List<IServiceObjectChangedDelegate>

Defines an event that is triggered when the service object changes.

getter/setter pair, inherited

ParentAttachment → ItemAttachment?

Gets the parent attachment of this item.

no setter, inherited

ParentFolderId → FolderId?

Get or sets the MimeContentUTF8 of this item.

no setter, inherited

PhoneNumbers → PhoneNumberDictionary

Gets an indexed list of phone numbers for the contact. For example, to set the home phone number, use the following syntax: PhoneNumbers[PhoneNumberKey.HomePhone] = "phone number"

no setter

PhoneticFirstName → String?

Gets the phonetic first name from the directory

no setter

PhoneticFullName → String?

Gets the full phonetic name from the directory

no setter

PhoneticLastName → String?

Gets the phonetic last name from the directory

no setter

PhysicalAddresses → PhysicalAddressDictionary

Gets an indexed list of physical addresses for the contact. For example, to set the business address, use the following syntax: PhysicalAddresses[PhysicalAddressKey.Business] = new PhysicalAddressEntry()

no setter

Preview → String?

Get or set the Flag value for this item.

no setter, inherited

Profession ↔ String?

Gets or sets the index of the contact's postal address. When set, PostalAddressIndex refers to an entry in the PhysicalAddresses indexed list.

getter/setter pair

PropertyBag → PropertyBag

The property bag holding property values for this object.

no setter, inherited

ReminderDueBy ↔ DateTime?

Gets a value indicating which response actions are allowed on this item. Examples of response actions are Reply and Forward.

getter/setter pair, inherited

RootItemId → ItemId?

Gets Id of the root item for this item.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Schema → ServiceObjectSchema

Gets the schema associated with this type of object.

no setter, inherited

Sensitivity ↔ Sensitivity?

Gets or sets the sensitivity of this item.

getter/setter pair, inherited

Service ↔ ExchangeService

Gets the ExchangeService the object is bound to.

getter/setter pair, inherited

Size → int?

Gets the size of this item.

no setter, inherited

SpouseName ↔ String?

Gets or sets the name of the contact's spouse.

getter/setter pair

StoreEntryId → Uint8List?

Gets the store entry id.

no setter, inherited

Subject ↔ String?

Gets or sets the subject of this item.

getter/setter pair, inherited

Surname ↔ String?

Gets or sets the surname of the contact.

getter/setter pair

TextBody → TextBody?

Gets the text body of the item.

no setter, inherited

UniqueBody → UniqueBody?

Gets the Id of the conversation this item is part of.

no setter, inherited

WebClientEditFormQueryString → String?

no setter, inherited

WebClientReadFormQueryString → String?

no setter, inherited

WeddingAnniversary ↔ DateTime?

Gets or sets the date of the contact's wedding anniversary.

getter/setter pair

Methods

Changed() → void

Triggers dispatch of the change event.

inherited

ClearChangeLog() → void

Clears the object's change log.

inherited

Delete(DeleteMode deleteMode, [bool suppressReadReceipts = false]) → Future<void>

Deletes the item. Calling this method results in a call to EWS.

inherited

GetChangeXmlElementName() → String

Gets the name of the change XML element.

inherited

GetContactPictureAttachment() → FileAttachment?

GetDeleteFieldXmlElementName() → String

Gets the name of the delete field XML element.

inherited

GetExtendedProperties() → ExtendedPropertyCollection?

Gets a list of extended properties defined on this object.

inherited

GetId() → ServiceId?

The unique Id of this object.

inherited

GetIdPropertyDefinition() → PropertyDefinition

The property definition for the Id of this object.

inherited

GetIsCustomDateTimeScopingRequired() → bool

Determines whether properties defined with ScopedDateTimePropertyDefinition require custom time zone scoping.

inherited

GetIsTimeZoneHeaderRequired(bool isUpdateOperation) → bool

Gets a value indicating whether a time zone SOAP header should be emitted in a CreateItem or UpdateItem request so this item can be property saved or updated.

inherited

GetLoadedPropertyDefinitions() → List<PropertyDefinitionBase?>

Gets the collection of loaded property definitions.

inherited

GetMinimumRequiredServerVersion() → ExchangeVersion

Gets the minimum required server version.

override

GetSchema() → ServiceObjectSchema

method to return the schema associated with this type of object.

override

getServiceObjectDefinitionAttribute() → ServiceObjectDefinitionAttribute

override

GetSetFieldXmlElementName() → String

Gets the name of the set field XML element.

inherited

GetXmlElementName() → String?

GetXmlElementName retrieves the XmlElementName of this type based on the EwsObjectDefinition attribute that decorates it, if present.

inherited

GetXmlElementNameOverride() → String?

This methods lets subclasses of ServiceObject override the default mechanism by which the XML element name associated with their type is retrieved.

inherited

HasUnprocessedAttachmentChanges() → bool

Gets a value indicating whether this instance has unprocessed attachment collection changes.

inherited

InternalCreate(FolderId? parentFolderId, MessageDisposition? messageDisposition, SendInvitationsMode? sendInvitationsMode) → Future<void>

Create item.

inherited

InternalDelete(DeleteMode deleteMode, SendCancellationsMode? sendCancellationsMode, AffectedTaskOccurrence? affectedTaskOccurrences, [bool suppressReadReceipts = false]) → Future<void>

Deletes the object.

inherited

InternalLoad(PropertySet propertySet) → Future<void>

Loads the specified set of properties on the object.

inherited

InternalRemoveContactPicture() → void

Removes the picture from local attachment collection.

InternalUpdate(FolderId? parentFolderId, ConflictResolutionMode conflictResolutionMode, MessageDisposition messageDisposition, SendInvitationsOrCancellationsMode? sendInvitationsOrCancellationsMode, [bool suppressReadReceipts = false]) → Future<Item?>

Update item.

inherited

Load() → Future<void>

Loads the first class properties. Calling this method results in a call to EWS.

inherited

LoadFromXml(EwsServiceXmlReader reader, bool clearPropertyBag) → Future<void>

Loads service object from XML.

inherited

LoadFromXmlWithPropertySet(EwsServiceXmlReader reader, bool clearPropertyBag, PropertySet? requestedPropertySet, bool summaryPropertiesOnly) → Future<void>

Loads service object from XML.

inherited

LoadWithPropertySet(PropertySet propertySet) → Future<void>

Loads the specified set of properties. Calling this method results in a call to EWS.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

RemoveContactPicture() → void

Removes the contact's picture.

RemoveExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition) → bool

Removes an extended property.

inherited

Save() → Future<void>

Saves this item in the default folder based on the item's type (for example, an e-mail message is saved to the Drafts folder). Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

inherited

SaveWithFolderId(FolderId? parentFolderId) → Future<void>

Saves this item in a specific folder. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

inherited

SaveWithWellKnownFolderName(WellKnownFolderName parentFolderName) → Future<void>

Saves this item in a specific folder. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added.

inherited

SetContactPicture(Uint8List content) → void

SetExtendedProperty(ExtendedPropertyDefinition extendedPropertyDefinition, Object value) → void

Creates a copy of this item in the specified folder. Calling this method results in a call to EWS.

inherited

SetSubject(String? subject) → void

Sets the subject.

inherited

ThrowIfThisIsAttachment() → void

Throws exception if this is attachment.

inherited

ThrowIfThisIsNew() → void

Throws exception if this is a new service object.

inherited

ThrowIfThisIsNotNew() → void

Throws exception if this is not a new service object.

inherited

toString() → String

A string representation of this object.

inherited

TryGetExtendedProperty<T>(ExtendedPropertyDefinition propertyDefinition, OutParam<T> propertyValueOutParam) → bool

Try to get the value of a specified extended property in this instance.

inherited

TryGetProperty(PropertyDefinitionBase propertyDefinition, OutParam<Object> propertyValueOutParam) → bool

Try to get the value of a specified property in this instance.

inherited

TryGetPropertyGeneric<T>(PropertyDefinitionBase propertyDefinition, OutParam<T> propertyValueOutParam) → bool

Try to get the value of a specified property in this instance.

inherited

Update(ConflictResolutionMode conflictResolutionMode, [bool suppressReadReceipts = false]) → Future<Item?>

Applies the local changes that have been made to this item. Calling this method results in at least one call to EWS. Mutliple calls to EWS might be made if attachments have been added or removed.

inherited

Validate() → void

Validates this instance.

override

WriteToXml(EwsServiceXmlWriter writer) → void

Writes service object as XML.

inherited

WriteToXmlForUpdate(EwsServiceXmlWriter writer) → void

Writes service object for update as XML.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

operator [](PropertyDefinitionBase propertyDefinition) → Object?

Gets the value of specified property in this instance.

inherited

Static Methods

BindWithItemId(ExchangeService service, ItemId? id) → Future<Contact>

Binds to an existing contact and loads its first class properties. Calling this method results in a call to EWS.

BindWithItemIdAndPropertySet(ExchangeService service, ItemId? id, PropertySet propertySet) → Future<Contact>

Binds to an existing contact and loads the specified set of properties. Calling this method results in a call to EWS.