microsoft.exchange.webservices.data
Class PullSubscription

java.lang.Object
  microsoft.exchange.webservices.data.SubscriptionBase
      microsoft.exchange.webservices.data.PullSubscription

public final class PullSubscription
extends SubscriptionBase

Represents a pull subscription.

Constructor Summary

protected

PullSubscription(ExchangeService service) Initializes a new instance.

Method Summary

GetEventsResults	getEvents() Obtains a collection of events that occurred on the subscribed folders since the point in time defined by the Watermark property.
boolean	isMoreEventsAvailable() Gets a value indicating whether more events are available on the server.
void	unsubscribe() Unsubscribes from the pull subscription.

Methods inherited from class microsoft.exchange.webservices.data.SubscriptionBase

getId, getService, getUsesWatermark, getWaterMark, loadFromXml, setId, setWaterMark

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PullSubscription

protected PullSubscription(ExchangeService service)
                    throws Exception

Initializes a new instance.

Parameters:

service - the service

Throws:

Exception - the exception

Method Detail

getEvents

public GetEventsResults getEvents()
                           throws Exception

Obtains a collection of events that occurred on the subscribed folders since the point in time defined by the Watermark property. When GetEvents succeeds, Watermark is updated.

Returns:

Returns a collection of events that occurred since the last watermark

Throws:

Exception - the exception

unsubscribe

public void unsubscribe()
                 throws Exception

Unsubscribes from the pull subscription.

Throws:

Exception - the exception

isMoreEventsAvailable

public boolean isMoreEventsAvailable()

Gets a value indicating whether more events are available on the server. MoreEventsAvailable is undefined (null) until GetEvents is called.

Returns:

true, if is more events available