|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmicrosoft.exchange.webservices.data.ServiceObject
microsoft.exchange.webservices.data.Conversation
public class Conversation
Represents a collection of Conversation related properties. Properties available on this object are defined in the ConversationSchema class.
Constructor Summary | |
---|---|
protected |
Conversation(ExchangeService service)
Initializes an unsaved local instance of Conversation. |
Method Summary | |
---|---|
void |
copyItemsInConversation(FolderId contextFolderId,
FolderId destinationFolderId)
Copies items in the specified conversation to a specific folder. |
void |
deleteItems(FolderId contextFolderId,
DeleteMode deleteMode)
Deletes items in the specified conversation. |
void |
disableAlwaysCategorizeItems(boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is no longer categorized. |
void |
disableAlwaysDeleteItems(boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is no longer moved to Deleted Items folder. |
void |
disableAlwaysMoveItemsInConversation(boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is no longer moved to a specific folder. |
void |
enableAlwaysCategorizeItems(java.lang.Iterable<java.lang.String> categories,
boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is always categorized. |
void |
enableAlwaysDeleteItems(boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is always moved to Deleted Items folder. |
void |
enableAlwaysMoveItems(FolderId destinationFolderId,
boolean processSynchronously)
Sets up a conversation so that any item received within that conversation is always moved to a specific folder. |
StringList |
getCategories()
Gets a list summarizing the categories stamped on messages in this conversation, in the current folder only. |
protected java.lang.String |
getChangeXmlElementName()
This method is not supported in this object. |
protected java.lang.String |
getDeleteFieldXmlElementName()
This method is not supported in this object. |
protected ExtendedPropertyCollection |
getExtendedProperties()
This method is not supported in this object. |
ConversationFlagStatus |
getFlagStatus()
Gets the flag status for this conversation, calculated by aggregating individual messages flag status in the current folder. |
StringList |
getGlobalCategories()
Gets a list summarizing the categories stamped on messages in this conversation, across all folders in the mailbox. |
ConversationFlagStatus |
getGlobalFlagStatus()
Gets the flag status for this conversation, calculated by aggregating individual messages flag status across all folders in the mailbox. |
boolean |
getGlobalHasAttachments()
Gets a value indicating if at least one message in this conversation, across all folders in the mailbox, has an attachment. |
Importance |
getGlobalImportance()
Gets the importance of this conversation, calculated by aggregating individual messages importance across all folders in the mailbox. |
StringList |
getGlobalItemClasses()
Gets a list summarizing the classes of the items in this conversation, across all folders in the mailbox. |
ItemIdCollection |
getGlobalItemIds()
Gets the Ids of the messages in this conversation, across all folders in the mailbox. |
java.util.Date |
getGlobalLastDeliveryTime()
Gets the delivery time of the message that was last received in this conversation across all folders in the mailbox. |
int |
getGlobalMessageCount()
Gets the total number of messages in this conversation across all folders in the mailbox. |
int |
getGlobalSize()
Gets the size of this conversation, calculated by adding the sizes of all messages in the conversation across all folders in the mailbox. |
StringList |
getGlobalUniqueRecipients()
Gets a list of all the people who have received messages in this conversation across all folders in the mailbox. |
StringList |
getGlobalUniqueSenders()
Gets a list of all the people who have sent messages in this conversation across all folders in the mailbox. |
StringList |
getGlobalUniqueUnreadSenders()
Gets a list of all the people who have sent messages that are currently unread in this conversation across all folders in the mailbox. |
int |
getGlobalUnreadCount()
Gets the total number of unread messages in this conversation across all folders in the mailbox. |
boolean |
getHasAttachments()
Gets a value indicating if at least one message in this conversation, in the current folder only, has an attachment. |
ConversationId |
getId()
Gets the Id of this Conversation. |
protected PropertyDefinition |
getIdPropertyDefinition()
The property definition for the Id of this object. |
Importance |
getImportance()
Gets the importance of this conversation, calculated by aggregating individual messages importance in the current folder only. |
protected boolean |
getIsTimeZoneHeaderRequired(boolean isUpdateOperation)
This method is not supported in this object. |
StringList |
getItemClasses()
Gets a list summarizing the classes of the items in this conversation, in the current folder only. |
ItemIdCollection |
getItemIds()
Gets the Ids of the messages in this conversation, in the current folder only. |
java.util.Date |
getLastDeliveryTime()
Gets the delivery time of the message that was last received in this conversation in the current folder only. |
int |
getMessageCount()
Gets the total number of messages in this conversation in the current folder only. |
protected ExchangeVersion |
getMinimumRequiredServerVersion()
Gets the minimum required server version. |
protected ServiceObjectSchema |
getSchema()
Internal method to return the schema associated with this type of object |
protected java.lang.String |
getSetFieldXmlElementName()
This method is not supported in this object. |
int |
getSize()
Gets the size of this conversation, calculated by adding the sizes of all messages in the conversation in the current folder only. |
java.lang.String |
getTopic()
Gets the topic of this Conversation. |
StringList |
getUniqueRecipients()
Gets a list of all the people who have received messages in this conversation in the current folder only. |
StringList |
getUniqueSenders()
Gets a list of all the people who have sent messages in this conversation in the current folder only. |
StringList |
getUniqueUnreadSenders()
Gets a list of all the people who have sent messages that are currently unread in this conversation in the current folder only. |
int |
getUnreadCount()
Gets the total number of unread messages in this conversation in the current folder only. |
protected void |
internalDelete(DeleteMode deleteMode,
SendCancellationsMode sendCancellationsMode,
AffectedTaskOccurrence affectedTaskOccurrences)
This is not supported in this object. |
protected void |
internalLoad(PropertySet propertySet)
This method is not supported in this object. |
void |
moveItemsInConversation(FolderId contextFolderId,
FolderId destinationFolderId)
Moves items in the specified conversation to a specific folder. |
void |
setReadStateForItemsInConversation(FolderId contextFolderId,
boolean isRead)
Sets the read state of items in the specified conversation. |
Methods inherited from class microsoft.exchange.webservices.data.ServiceObject |
---|
addServiceObjectChangedEvent, changed, clearChangeLog, clearServiceObjectChangedEvent, getIsCustomDateTimeScopingRequired, getLoadedPropertyDefinitions, getObjectFromPropertyDefinition, getPropertyBag, getService, getXmlElementName, getXmlElementNameOverride, isDirty, isNew, load, load, loadFromXml, loadFromXml, removeServiceObjectChangedEvent, schema, setService, throwIfThisIsNew, throwIfThisIsNotNew, tryGetExtendedProperty, tryGetProperty, tryGetProperty, validate, writeToXml, writeToXmlForUpdate |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected Conversation(ExchangeService service) throws java.lang.Exception
service
- The service
The ExchangeService object to which the item will be bound.
java.lang.Exception
Method Detail |
---|
protected ServiceObjectSchema getSchema()
getSchema
in class ServiceObject
protected ExchangeVersion getMinimumRequiredServerVersion()
getMinimumRequiredServerVersion
in class ServiceObject
protected PropertyDefinition getIdPropertyDefinition()
getIdPropertyDefinition
in class ServiceObject
protected void internalLoad(PropertySet propertySet)
internalLoad
in class ServiceObject
propertySet
- The propertySet
The properties to load.protected void internalDelete(DeleteMode deleteMode, SendCancellationsMode sendCancellationsMode, AffectedTaskOccurrence affectedTaskOccurrences)
internalDelete
in class ServiceObject
deleteMode
- The deleteMode
The deletion mode.sendCancellationsMode
- The sendCancellationsMode
Indicates whether meeting cancellation messages should be sent.affectedTaskOccurrences
- The affectedTaskOccurrences
Indicate which occurrence of a recurring task should be deleted.protected java.lang.String getChangeXmlElementName()
getChangeXmlElementName
in class ServiceObject
protected java.lang.String getDeleteFieldXmlElementName()
getDeleteFieldXmlElementName
in class ServiceObject
protected java.lang.String getSetFieldXmlElementName()
getSetFieldXmlElementName
in class ServiceObject
protected boolean getIsTimeZoneHeaderRequired(boolean isUpdateOperation)
getIsTimeZoneHeaderRequired
in class ServiceObject
isUpdateOperation
- Indicates whether
the operation being petrformed is an update operation.
protected ExtendedPropertyCollection getExtendedProperties()
getExtendedProperties
in class ServiceObject
public void enableAlwaysCategorizeItems(java.lang.Iterable<java.lang.String> categories, boolean processSynchronously) throws ServiceResponseException, java.lang.IndexOutOfBoundsException, java.lang.Exception
categories
- The categories that should be stamped on items in the conversation.processSynchronously
- Indicates whether the method should
return only once enabling this rule and stamping existing items
in the conversation is completely done.
If processSynchronously is false, the method returns immediately.
java.lang.Exception
java.lang.IndexOutOfBoundsException
ServiceResponseException
public void disableAlwaysCategorizeItems(boolean processSynchronously) throws ServiceResponseException, java.lang.IndexOutOfBoundsException, java.lang.Exception
processSynchronously
- Indicates whether the method should
return only once disabling this rule and
removing the categories from existing items
in the conversation is completely done. If processSynchronously
is false, the method returns immediately.
java.lang.Exception
java.lang.IndexOutOfBoundsException
ServiceResponseException
public void enableAlwaysDeleteItems(boolean processSynchronously) throws ServiceResponseException, java.lang.IndexOutOfBoundsException, java.lang.Exception
processSynchronously
- Indicates whether the method should
return only once enabling this rule and deleting existing items
in the conversation is completely done. If processSynchronously
is false, the method returns immediately.
java.lang.Exception
java.lang.IndexOutOfBoundsException
ServiceResponseException
public void disableAlwaysDeleteItems(boolean processSynchronously) throws ServiceResponseException, java.lang.IndexOutOfBoundsException, java.lang.Exception
processSynchronously
- Indicates whether the method should return
only once disabling this rule and restoring the items
in the conversation is completely done. If processSynchronously
is false, the method returns immediately.
java.lang.Exception
java.lang.IndexOutOfBoundsException
ServiceResponseException
public void enableAlwaysMoveItems(FolderId destinationFolderId, boolean processSynchronously) throws ServiceResponseException, java.lang.IndexOutOfBoundsException, java.lang.Exception
destinationFolderId
- The Id of the folder to which conversation items should be moved.processSynchronously
- Indicates whether the method should return only
once enabling this rule
and moving existing items in the conversation is completely done.
If processSynchronously is false, the method returns immediately.
java.lang.Exception
java.lang.IndexOutOfBoundsException
ServiceResponseException
public void disableAlwaysMoveItemsInConversation(boolean processSynchronously) throws ServiceResponseException, java.lang.IndexOutOfBoundsException, java.lang.Exception
processSynchronously
- Indicates whether the method should return only
once disabling this
rule is completely done. If processSynchronously
is false, the method returns immediately.
java.lang.Exception
java.lang.IndexOutOfBoundsException
ServiceResponseException
public void deleteItems(FolderId contextFolderId, DeleteMode deleteMode) throws ServiceResponseException, java.lang.IndexOutOfBoundsException, java.lang.Exception
contextFolderId
- The Id of the folder items must belong
to in order to be deleted. If contextFolderId is
null, items across the entire mailbox are deleted.deleteMode
- The deletion mode.
java.lang.Exception
java.lang.IndexOutOfBoundsException
ServiceResponseException
public void moveItemsInConversation(FolderId contextFolderId, FolderId destinationFolderId) throws ServiceResponseException, java.lang.IndexOutOfBoundsException, java.lang.Exception
contextFolderId
- The Id of the folder items must belong to
in order to be moved. If contextFolderId is null,
items across the entire mailbox are moved.destinationFolderId
- The Id of the destination folder.
java.lang.Exception
java.lang.IndexOutOfBoundsException
ServiceResponseException
public void copyItemsInConversation(FolderId contextFolderId, FolderId destinationFolderId) throws ServiceResponseException, java.lang.IndexOutOfBoundsException, java.lang.Exception
contextFolderId
- The Id of the folder items must belong to in
order to be copied. If contextFolderId
is null, items across the entire mailbox are copied.destinationFolderId
- The Id of the destination folder.
java.lang.Exception
java.lang.IndexOutOfBoundsException
ServiceResponseException
public void setReadStateForItemsInConversation(FolderId contextFolderId, boolean isRead) throws ServiceResponseException, java.lang.IndexOutOfBoundsException, java.lang.Exception
contextFolderId
- The Id of the folder items must
belong to in order for their read state to
be set. If contextFolderId is null, the read states of
items across the entire mailbox are set.isRead
- if set to java.lang.Exception
java.lang.IndexOutOfBoundsException
ServiceResponseException
public ConversationId getId() throws ServiceLocalException
getId
in class ServiceObject
ServiceLocalException
java.lang.Exception
public java.lang.String getTopic() throws ArgumentException
ArgumentException
public StringList getUniqueRecipients() throws java.lang.Exception
java.lang.Exception
public StringList getGlobalUniqueRecipients() throws java.lang.Exception
java.lang.Exception
public StringList getUniqueUnreadSenders() throws ArgumentException
ArgumentException
public StringList getGlobalUniqueUnreadSenders() throws ArgumentException
ArgumentException
public StringList getUniqueSenders() throws java.lang.Exception
java.lang.Exception
public StringList getGlobalUniqueSenders() throws java.lang.Exception
java.lang.Exception
public java.util.Date getLastDeliveryTime() throws java.lang.Exception
java.lang.Exception
public java.util.Date getGlobalLastDeliveryTime() throws java.lang.Exception
java.lang.Exception
public StringList getCategories() throws ArgumentException
ArgumentException
public StringList getGlobalCategories() throws ArgumentException
ArgumentException
public ConversationFlagStatus getFlagStatus() throws ArgumentException
ArgumentException
public ConversationFlagStatus getGlobalFlagStatus() throws ArgumentException
ArgumentException
public boolean getHasAttachments() throws ServiceLocalException
ServiceLocalException
public boolean getGlobalHasAttachments() throws ServiceLocalException
ServiceLocalException
public int getMessageCount() throws ServiceLocalException
ServiceLocalException
public int getGlobalMessageCount() throws ServiceLocalException
ServiceLocalException
public int getUnreadCount() throws ArgumentException
ArgumentException
public int getGlobalUnreadCount() throws ArgumentException
ArgumentException
public int getSize() throws ServiceLocalException
ServiceLocalException
public int getGlobalSize() throws ServiceLocalException
ServiceLocalException
public StringList getItemClasses() throws java.lang.Exception
java.lang.Exception
public StringList getGlobalItemClasses() throws java.lang.Exception
java.lang.Exception
public Importance getImportance() throws java.lang.Exception
java.lang.Exception
public Importance getGlobalImportance() throws java.lang.Exception
java.lang.Exception
public ItemIdCollection getItemIds() throws java.lang.Exception
java.lang.Exception
public ItemIdCollection getGlobalItemIds() throws java.lang.Exception
java.lang.Exception
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |