Synchronization operations complete, SyncFolderHierarchy and SyncFolderItems works!!. closes gautamsi#42

Author: gautamsi

README.md

@@ -28,6 +28,16 @@ Code sample from [EWS Managed API 2.1.](https://msdn.microsoft.com/en-us/library
 Api document generated using TypeDoc and is hosted at [ews-javascript-api.github.io/api](http://ews-javascript-api.github.io/api). 
 Check [Wiki](https://github.com/gautamsi/ews-javascript-api/wiki) for more details
 
+# Whats new v0.3.0 (including 0.2.8)
+
+* new: ***Mailbox synchronization*** now works, `SyncFolderItems` and `SyncFolderHierarchy` ExchangeService now availbale [see MSDN for example](https://msdn.microsoft.com/en-us/library/office/dn440952(v=exchg.150).aspx)
+* new: ***Pull Subscription*** should now work [use MSDN example](https://msdn.microsoft.com/en-us/library/office/dn458790(v=exchg.150).aspx)
+* new: `SetTeamMailbox` and `UnpinTeamMailbox` ExchangeService methods now availbale. (`SetTeamMailbox` does not work with Office 365, Access Denied error, on-prem test is pending) See official MSDN reference for detail [ExchangeService.UnpinTeamMailbox method](https://msdn.microsoft.com/en-us/library/office/microsoft.exchange.webservices.data.exchangeservice.unpinteammailbox(v=exchg.80).aspx)
+* new: `GetRooms` and `GetRoomLists` ExchangeService methods now availbale. See official MSDN reference for detail [ExchangeService.GetRooms method](https://msdn.microsoft.com/en-us/library/office/microsoft.exchange.webservices.data.exchangeservice.getrooms(v=exchg.80).aspx) and [ExchangeService.GetRoomLists method](https://msdn.microsoft.com/en-us/library/office/microsoft.exchange.webservices.data.exchangeservice.getroomlists(v=exchg.80).aspx)
+* new: `ConvertId` and `ConvertIds` ExchangeService methods now availbale, see MSDN detail at [EWS Identifiers in Exchange](https://msdn.microsoft.com/EN-US/library/office/dn605828(v=exchg.150).aspx)
+* new: `GetClientAccessToken` ExchangeService method now availbale, used with "Mail App" management, App management (#41) coming later
+* fix: `ImpersonatedUserId` bug #34
+
 # Whats new v0.2.7 (including 0.2.5 and 0.2.6)
 
 * new: Streaming Notification code updated, see issue #24 for example. More details at [How to: Stream notifications about mailbox events by using EWS in Exchange](https://msdn.microsoft.com/en-us/library/office/dn458792(v=exchg.150).aspx)
@@ -155,27 +165,37 @@ Review Core/ExchangeService methods in api document, Any method not marked priva
 AutodiscoverUrl 
 BindToGroupItems 
 BindToItems 
+ConvertId 
+ConvertIds 
 CopyItems 
 CreateItems 
 DeleteItems 
 ExpandGroup 
 FindAppointments 
 FindFolders 
 FindItems 
-GetAttachments *new 
+GetAttachments 
+GetClientAccessToken 
 GetPasswordExpirationDate 
+GetRoomLists 
+GetRooms 
 GetUserAvailability 
+GetUserOofSettings 
+GetUserOofSettings 
 LoadPropertiesForItems 
 MarkAsJunk 
 MoveItems 
 ResolveName 
-UpdateItems 
-GetUserOofSettings  
+SetTeamMailbox  
+SetUserOofSettings 
 SetUserOofSettings 
+SubscribeToPullNotifications 
 SubscribeToStreamingNotifications 
 SubscribeToStreamingNotificationsOnAllFolders 
-GetUserOofSettings 
-SetUserOofSettings 
+SyncFolderHierarchy 
+SyncFolderItems 
+UnpinTeamMailbox 
+UpdateItems 
 
 
 

package.json

@@ -1,6 +1,6 @@
 {
  "name": "ews-javascript-api",
- "version": "0.2.8",
+ "version": "0.3.0",
  "description": "EWS Managed api in JavaScript",
  "main": "js/ExchangeWebService.js",
  "scripts": {

src/js/Core/ExchangeService.ts

@@ -14,6 +14,7 @@ import {AvailabilityData} from "../Enumerations/AvailabilityData";
 import {AvailabilityOptions} from "../Misc/Availability/AvailabilityOptions";
 import {BodyType} from "../Enumerations/BodyType";
 import {CalendarView} from "../Search/CalendarView";
+import {ChangeCollection} from "../Sync/ChangeCollection";
 import {ClientAccessTokenRequest} from "../ComplexProperties/ClientAccessTokenRequest";
 import {ClientAccessTokenType} from "../Enumerations/ClientAccessTokenType";
 import {ConflictResolutionMode} from "../Enumerations/ConflictResolutionMode";
@@ -49,6 +50,7 @@ import {FindItemRequest} from "./Requests/FindItemRequest";
 import {FindItemResponse} from "./Responses/FindItemResponse";
 import {FindItemsResults} from "../Search/FindItemsResults";
 import {Folder} from "./ServiceObjects/Folders/Folder";
+import {FolderChange} from "../Sync/FolderChange";
 import {FolderId} from "../ComplexProperties/FolderId";
 import {FolderView} from "../Search/FolderView";
 import {GetAttachmentRequest} from "./Requests/GetAttachmentRequest";
@@ -77,6 +79,7 @@ import {IFileAttachmentContentHandler} from "../Interfaces/IFileAttachmentConten
 import {ImpersonatedUserId} from "../Misc/ImpersonatedUserId";
 import {IPromise, IXHROptions} from "../Interfaces";
 import {Item} from "./ServiceObjects/Items/Item";
+import {ItemChange} from "../Sync/ItemChange";
 import {ItemId} from "../ComplexProperties/ItemId";
 import {KeyValuePair} from "../AltDictionary";
 import {Mailbox} from "../ComplexProperties/Mailbox";
@@ -124,6 +127,9 @@ import {Strings} from "../Strings";
 import {SubscribeToPullNotificationsRequest} from "./Requests/SubscribeToPullNotificationsRequest";
 import {SubscribeToPushNotificationsRequest} from "./Requests/SubscribeToPushNotificationsRequest";
 import {SubscribeToStreamingNotificationsRequest} from "./Requests/SubscribeToStreamingNotificationsRequest";
+import {SyncFolderHierarchyRequest} from "./Requests/SyncFolderHierarchyRequest";
+import {SyncFolderItemsRequest} from "./Requests/SyncFolderItemsRequest";
+import {SyncFolderItemsScope} from "../Enumerations/SyncFolderItemsScope";
 import {TeamMailboxLifecycleState} from "../Enumerations/TeamMailboxLifecycleState";
 import {TimeWindow} from "../Misc/Availability/TimeWindow";
 import {TraceFlags} from "../Enumerations/TraceFlags";
@@ -2061,17 +2067,165 @@ export class ExchangeService extends ExchangeServiceBase {
 
  // BeginSyncFolderItems(callback: Function /*System.AsyncCallback*/, state: any, syncFolderId: FolderId, propertySet: PropertySet, ignoredItemIds: any[] /*System.Collections.Generic.IEnumerable<T>*/, maxChangesReturned: number, syncScope: SyncFolderItemsScope, syncState: string): Function /*System.IAsyncResult*/ { throw new Error("ExchangeService.ts - BeginSyncFolderItems : Not implemented."); }
  // BeginSyncFolderItems(callback: Function /*System.AsyncCallback*/, state: any, syncFolderId: FolderId, propertySet: PropertySet, ignoredItemIds: any[] /*System.Collections.Generic.IEnumerable<T>*/, maxChangesReturned: number, numberOfDays: number, syncScope: SyncFolderItemsScope, syncState: string): Function /*System.IAsyncResult*/ { throw new Error("ExchangeService.ts - BeginSyncFolderItems : Not implemented."); }
- //BuildSyncFolderItemsRequest(syncFolderId: FolderId, propertySet: PropertySet, ignoredItemIds: any[] /*System.Collections.Generic.IEnumerable<T>*/, maxChangesReturned: number, syncScope: SyncFolderItemsScope, syncState: string): SyncFolderItemsRequest { throw new Error("ExchangeService.ts - BuildSyncFolderItemsRequest : Not implemented."); }
+
+ /**
+ * Builds a request to synchronize the items of a specific folder.
+ *
+ * @param {FolderId} syncFolderId The Id of the folder containing the items to synchronize with.
+ * @param {PropertySet} propertySet The set of properties to retrieve for synchronized items.
+ * @param {ItemId[]} ignoredItemIds The optional list of item Ids that should be ignored.
+ * @param {number} maxChangesReturned The maximum number of changes that should be returned.
+ * @param {number} numberOfDays Limit the changes returned to this many days ago; 0 means no limit.
+ * @param {SyncFolderItemsScope} syncScope The sync scope identifying items to include in the ChangeCollection.
+ * @param {string} syncState The optional sync state representing the point in time when to start the synchronization.
+ * @return {SyncFolderItemsRequest} A request to synchronize the items of a specific folder.
+ */
+ private BuildSyncFolderItemsRequest(syncFolderId: FolderId, propertySet: PropertySet, ignoredItemIds: ItemId[], maxChangesReturned: number, numberOfDays: number, syncScope: SyncFolderItemsScope, syncState: string): SyncFolderItemsRequest {
+ EwsUtilities.ValidateParam(syncFolderId, "syncFolderId");
+ EwsUtilities.ValidateParam(propertySet, "propertySet");
+
+ let request: SyncFolderItemsRequest = new SyncFolderItemsRequest(this);
+
+ request.SyncFolderId = syncFolderId;
+ request.PropertySet = propertySet;
+ if (ignoredItemIds != null) {
+ request.IgnoredItemIds.AddRange(ignoredItemIds);
+ }
+ request.MaxChangesReturned = maxChangesReturned;
+ request.NumberOfDays = numberOfDays;
+ request.SyncScope = syncScope;
+ request.SyncState = syncState;
+
+ return request;
+ }
  //EndSyncFolderItems(asyncResult: Function /*System.IAsyncResult*/): ChangeCollection<ItemChange> { throw new Error("ExchangeService.ts - EndSyncFolderItems : Not implemented."); }
- //SyncFolderItems(syncFolderId: FolderId, propertySet: PropertySet, ignoredItemIds: any[] /*System.Collections.Generic.IEnumerable<T>*/, maxChangesReturned: number, syncScope: SyncFolderItemsScope, syncState: string): ChangeCollection<ItemChange> { throw new Error("ExchangeService.ts - SyncFolderItems : Not implemented."); }
- //SyncFolderItems(syncFolderId: FolderId, propertySet: PropertySet, ignoredItemIds: any[] /*System.Collections.Generic.IEnumerable<T>*/, maxChangesReturned: number, numberOfDays: number, syncScope: SyncFolderItemsScope, syncState: string): ChangeCollection<ItemChange> { throw new Error("ExchangeService.ts - SyncFolderItems : Not implemented."); }
+
+ /**
+ * Synchronizes the items of a specific folder. Calling this method results in a call to EWS.
+ *
+ * @param {FolderId} syncFolderId The Id of the folder containing the items to synchronize with.
+ * @param {PropertySet} propertySet The set of properties to retrieve for synchronized items.
+ * @param {ItemId[]} ignoredItemIds The optional list of item Ids that should be ignored.
+ * @param {number} maxChangesReturned The maximum number of changes that should be returned.
+ * @param {number} numberOfDays Limit the changes returned to this many days ago; 0 means no limit.
+ * @param {SyncFolderItemsScope} syncScope The sync scope identifying items to include in the ChangeCollection.
+ * @param {string} syncState The optional sync state representing the point in time when to start the synchronization.
+ * @return {IPromise<ChangeCollection<ItemChange>>} A ChangeCollection containing a list of changes that occurred in the specified folder :Promise.
+ */
+ SyncFolderItems(syncFolderId: FolderId, propertySet: PropertySet, ignoredItemIds: ItemId[], maxChangesReturned: number, syncScope: SyncFolderItemsScope, syncState: string): IPromise<ChangeCollection<ItemChange>>;
+ /**
+ * Synchronizes the items of a specific folder. Calling this method results in a call to EWS.
+ *
+ * @param {FolderId} syncFolderId The Id of the folder containing the items to synchronize with.
+ * @param {PropertySet} propertySet The set of properties to retrieve for synchronized items.
+ * @param {ItemId[]} ignoredItemIds The optional list of item Ids that should be ignored.
+ * @param {number} maxChangesReturned The maximum number of changes that should be returned.
+ * @param {number} numberOfDays Limit the changes returned to this many days ago; 0 means no limit.
+ * @param {SyncFolderItemsScope} syncScope The sync scope identifying items to include in the ChangeCollection.
+ * @param {string} syncState The optional sync state representing the point in time when to start the synchronization.
+ * @return {IPromise<ChangeCollection<ItemChange>>} A ChangeCollection containing a list of changes that occurred in the specified folder :Promise.
+ */
+ SyncFolderItems(syncFolderId: FolderId, propertySet: PropertySet, ignoredItemIds: ItemId[], maxChangesReturned: number, numberOfDays: number, syncScope: SyncFolderItemsScope, syncState: string): IPromise<ChangeCollection<ItemChange>>;
+ SyncFolderItems(
+ syncFolderId: FolderId,
+ propertySet: PropertySet,
+ ignoredItemIds: ItemId[],
+ maxChangesReturned: number,
+ numberOfDaysOrSyncScope: number | SyncFolderItemsScope,
+ syncScopeOrSyncState: SyncFolderItemsScope | string,
+ syncState: string = null): IPromise<ChangeCollection<ItemChange>> {
+
+ let numberOfDays: number = 0;
+ let syncScope: SyncFolderItemsScope;
+
+ if (arguments.length === 6) {
+ syncState = <string>syncScopeOrSyncState;
+ syncScope = numberOfDaysOrSyncScope;
+ }
+ else {
+ numberOfDays = numberOfDaysOrSyncScope;
+ syncScope = <SyncFolderItemsScope>syncScopeOrSyncState;
+ }
+
+ return this.BuildSyncFolderItemsRequest(
+ syncFolderId,
+ propertySet,
+ ignoredItemIds,
+ maxChangesReturned,
+ numberOfDays,
+ syncScope,
+ syncState).Execute().then((responses) => {
+ return responses.__thisIndexer(0).Changes;
+ });
+ }
 
  // BeginSyncFolderHierarchy(callback: Function /*System.AsyncCallback*/, state: any, propertySet: PropertySet, syncState: string): Function /*System.IAsyncResult*/ { throw new Error("ExchangeService.ts - BeginSyncFolderHierarchy : Not implemented."); }
  // //BeginSyncFolderHierarchy(callback: Function /*System.AsyncCallback*/, state: any, syncFolderId: FolderId, propertySet: PropertySet, syncState: string): Function /*System.IAsyncResult*/ { throw new Error("ExchangeService.ts - BeginSyncFolderHierarchy : Not implemented."); }
- //BuildSyncFolderHierarchyRequest(syncFolderId: FolderId, propertySet: PropertySet, syncState: string): SyncFolderHierarchyRequest { throw new Error("ExchangeService.ts - BuildSyncFolderHierarchyRequest : Not implemented."); }
+
+ /**
+ * Builds a request to synchronize the specified folder hierarchy of the mailbox this Service is connected to.
+ *
+ * @param {FolderId} syncFolderId The Id of the folder containing the items to synchronize with. A null value indicates the root folder of the mailbox.
+ * @param {PropertySet} propertySet The set of properties to retrieve for synchronized items.
+ * @param {string} syncState The optional sync state representing the point in time when to start the synchronization.
+ * @return {SyncFolderHierarchyRequest} A request to synchronize the specified folder hierarchy of the mailbox this Service is connected to.
+ */
+ private BuildSyncFolderHierarchyRequest(syncFolderId: FolderId, propertySet: PropertySet, syncState: string): SyncFolderHierarchyRequest {
+ EwsUtilities.ValidateParamAllowNull(syncFolderId, "syncFolderId"); // Null syncFolderId is allowed
+ EwsUtilities.ValidateParam(propertySet, "propertySet");
+
+ let request: SyncFolderHierarchyRequest = new SyncFolderHierarchyRequest(this);
+
+ request.PropertySet = propertySet;
+ request.SyncFolderId = syncFolderId;
+ request.SyncState = syncState;
+
+ return request;
+ }
+
  //EndSyncFolderHierarchy(asyncResult: Function /*System.IAsyncResult*/): ChangeCollection<FolderChange> { throw new Error("ExchangeService.ts - EndSyncFolderHierarchy : Not implemented."); }
- ////SyncFolderHierarchy(syncFolderId: FolderId, propertySet: PropertySet, syncState: string): ChangeCollection<FolderChange> { throw new Error("ExchangeService.ts - SyncFolderHierarchy : Not implemented."); }
- //SyncFolderHierarchy(propertySet: PropertySet, syncState: string): ChangeCollection<FolderChange> { throw new Error("ExchangeService.ts - SyncFolderHierarchy : Not implemented."); }
+
+ /**
+ * Synchronizes the sub-folders of a specific folder. Calling this method results in a call to EWS.
+ *
+ * @param {FolderId} syncFolderId The Id of the folder containing the items to synchronize with. A null value indicates the root folder of the mailbox.
+ * @param {PropertySet} propertySet The set of properties to retrieve for synchronized items.
+ * @param {string} syncState The optional sync state representing the point in time when to start the synchronization.
+ * @return {IPromise<ChangeCollection<FolderChange>>} A ChangeCollection containing a list of changes that occurred in the specified folder :Promise.
+ */
+ SyncFolderHierarchy(syncFolderId: FolderId, propertySet: PropertySet, syncState: string): IPromise<ChangeCollection<FolderChange>>;
+ /**
+ * Synchronizes the entire folder hierarchy of the mailbox this Service is connected to. Calling this method results in a call to EWS.
+ *
+ * @param {PropertySet} propertySet The set of properties to retrieve for synchronized items.
+ * @param {string} syncState The optional sync state representing the point in time when to start the synchronization.
+ * @return {IPromise<ChangeCollection<FolderChange>>} A ChangeCollection containing a list of changes that occurred in the specified folder :Promise.
+ */
+ SyncFolderHierarchy(propertySet: PropertySet, syncState: string): IPromise<ChangeCollection<FolderChange>>;
+ SyncFolderHierarchy(
+ syncFolderIdOrPropertySet: FolderId | PropertySet,
+ propertySetOrSyncState: PropertySet | string,
+ syncState: string = null): IPromise<ChangeCollection<FolderChange>> {
+
+ let syncFolderId: FolderId = null;
+ let propertySet: PropertySet;
+
+ if (arguments.length === 2) {
+ propertySet = <PropertySet>syncFolderIdOrPropertySet;
+ syncState = <string>propertySetOrSyncState;
+ }
+ else {
+ syncFolderId = <FolderId>syncFolderIdOrPropertySet;
+ propertySet = <PropertySet>propertySetOrSyncState;
+ }
+
+ return this.BuildSyncFolderHierarchyRequest(
+ syncFolderId,
+ propertySet,
+ syncState).Execute().then((responses) => {
+ return responses.__thisIndexer(0).Changes;
+ });
+ }
  /* #endregion Synchronization operations */