Class SyncFolderItemsRequest
- java.lang.Object
-
- microsoft.exchange.webservices.data.core.request.ServiceRequestBase<T>
-
- microsoft.exchange.webservices.data.core.request.SimpleServiceRequestBase<ServiceResponseCollection<TResponse>>
-
- microsoft.exchange.webservices.data.core.request.MultiResponseServiceRequest<SyncFolderItemsResponse>
-
- microsoft.exchange.webservices.data.core.request.SyncFolderItemsRequest
-
public class SyncFolderItemsRequest extends MultiResponseServiceRequest<SyncFolderItemsResponse>
Represents a SyncFolderItems request.
-
-
Constructor Summary
Constructors Constructor Description SyncFolderItemsRequest(ExchangeService service)Initializes a new instance of the class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected SyncFolderItemsResponsecreateServiceResponse(ExchangeService service, int responseIndex)Creates service response.protected intgetExpectedResponseMessageCount()Gets the expected response message count.ItemIdWrapperListgetIgnoredItemIds()Gets the list of ignored item ids.intgetMaxChangesReturned()Gets the maximum number of changes returned by SyncFolderItems.protected ExchangeVersiongetMinimumRequiredServerVersion()Gets the request version.PropertySetgetPropertySet()Gets or sets the property set.protected StringgetResponseMessageXmlElementName()Gets the name of the response message XML element.protected StringgetResponseXmlElementName()Gets the name of the response XML element.FolderIdgetSyncFolderId()Gets the sync folder id.SyncFolderItemsScopegetSyncScope()Gets the scope of the sync.StringgetSyncState()Gets the state of the sync.StringgetXmlElementName()Gets the name of the XML element.voidsetMaxChangesReturned(int maxChangesReturned)Sets the max changes returned.voidsetPropertySet(PropertySet propertySet)Sets the property set.voidsetSyncFolderId(FolderId syncFolderId)Sets the sync folder id.voidsetSyncScope(SyncFolderItemsScope syncScope)Sets the sync scope.voidsetSyncState(String syncState)Sets the sync state.protected voidvalidate()Validates request.protected voidwriteElementsToXml(EwsServiceXmlWriter writer)Writes XML elements.-
Methods inherited from class microsoft.exchange.webservices.data.core.request.MultiResponseServiceRequest
endExecute, execute, getErrorHandlingMode, parseResponse
-
Methods inherited from class microsoft.exchange.webservices.data.core.request.SimpleServiceRequestBase
beginExecute, endInternalExecute, internalExecute
-
Methods inherited from class microsoft.exchange.webservices.data.core.request.ServiceRequestBase
buildEwsHttpPoolingWebRequest, buildEwsHttpWebRequest, getEwsHttpWebResponse, getResponseStream, getService, processWebException, readPreamble, readResponse, readResponse, readSoapFault, throwIfNotSupportedByRequestedServerVersion, traceResponse, validateAndEmitRequest, writeAttributesToXml, writeBodyToXml, writeToXml
-
-
-
-
Constructor Detail
-
SyncFolderItemsRequest
public SyncFolderItemsRequest(ExchangeService service) throws Exception
Initializes a new instance of the class.- Parameters:
service- the service- Throws:
Exception
-
-
Method Detail
-
createServiceResponse
protected SyncFolderItemsResponse createServiceResponse(ExchangeService service, int responseIndex)
Creates service response.- Specified by:
createServiceResponsein classMultiResponseServiceRequest<SyncFolderItemsResponse>- Parameters:
service- the serviceresponseIndex- the response index- Returns:
- Service response
-
getExpectedResponseMessageCount
protected int getExpectedResponseMessageCount()
Gets the expected response message count.- Specified by:
getExpectedResponseMessageCountin classMultiResponseServiceRequest<SyncFolderItemsResponse>- Returns:
- Number of expected response messages.
-
getXmlElementName
public String getXmlElementName()
Gets the name of the XML element.- Specified by:
getXmlElementNamein classServiceRequestBase<ServiceResponseCollection<SyncFolderItemsResponse>>- Returns:
- XML element name
-
getResponseXmlElementName
protected String getResponseXmlElementName()
Gets the name of the response XML element.- Specified by:
getResponseXmlElementNamein classServiceRequestBase<ServiceResponseCollection<SyncFolderItemsResponse>>- Returns:
- XML element name
-
getResponseMessageXmlElementName
protected String getResponseMessageXmlElementName()
Gets the name of the response message XML element.- Specified by:
getResponseMessageXmlElementNamein classMultiResponseServiceRequest<SyncFolderItemsResponse>- Returns:
- XML element name
-
validate
protected void validate() throws Exception
Validates request.- Overrides:
validatein classServiceRequestBase<ServiceResponseCollection<SyncFolderItemsResponse>>- Throws:
Exception- the exception
-
writeElementsToXml
protected void writeElementsToXml(EwsServiceXmlWriter writer) throws Exception
Writes XML elements.- Specified by:
writeElementsToXmlin classServiceRequestBase<ServiceResponseCollection<SyncFolderItemsResponse>>- Parameters:
writer- the writer- Throws:
Exception- the exception
-
getMinimumRequiredServerVersion
protected ExchangeVersion getMinimumRequiredServerVersion()
Gets the request version.- Specified by:
getMinimumRequiredServerVersionin classServiceRequestBase<ServiceResponseCollection<SyncFolderItemsResponse>>- Returns:
- Earliest Exchange version in which this request is supported.
-
getPropertySet
public PropertySet getPropertySet()
Gets or sets the property set.- Returns:
- the property set
-
setPropertySet
public void setPropertySet(PropertySet propertySet)
Sets the property set.- Parameters:
propertySet- the new property set
-
getSyncFolderId
public FolderId getSyncFolderId()
Gets the sync folder id.- Returns:
- the sync folder id
-
setSyncFolderId
public void setSyncFolderId(FolderId syncFolderId)
Sets the sync folder id.- Parameters:
syncFolderId- the new sync folder id
-
getSyncScope
public SyncFolderItemsScope getSyncScope()
Gets the scope of the sync.- Returns:
- the sync scope
-
setSyncScope
public void setSyncScope(SyncFolderItemsScope syncScope)
Sets the sync scope.- Parameters:
syncScope- the new sync scope
-
getSyncState
public String getSyncState()
Gets the state of the sync.- Returns:
- the sync state
-
setSyncState
public void setSyncState(String syncState)
Sets the sync state.- Parameters:
syncState- the new sync state
-
getIgnoredItemIds
public ItemIdWrapperList getIgnoredItemIds()
Gets the list of ignored item ids.- Returns:
- the ignored item ids
-
getMaxChangesReturned
public int getMaxChangesReturned()
Gets the maximum number of changes returned by SyncFolderItems. Values must be between 1 and 512. Default is 100.- Returns:
- the max changes returned
-
setMaxChangesReturned
public void setMaxChangesReturned(int maxChangesReturned) throws ArgumentException
Sets the max changes returned.- Parameters:
maxChangesReturned- the new max changes returned- Throws:
ArgumentException- the argument exception
-
-