Added the ability to submit a user description and email address for the event.

niemyjski · niemyjski · commit 693cff9e51d6 · 2015-05-19T18:12:15.000-05:00
diff --git a/src/ExceptionlessClient.ts b/src/ExceptionlessClient.ts
@@ -3,9 +3,11 @@ import { Configuration } from './configuration/Configuration';
 import { EventBuilder } from './EventBuilder';
 import { IEvent } from './models/IEvent';
 import { IError } from './models/IError';
+import { IUserDescription } from './models/IUserDescription';
 import { EventPluginContext } from './plugins/EventPluginContext';
 import { EventPluginManager } from './plugins/EventPluginManager';
 import { ContextData } from './plugins/ContextData';
+import { SubmissionResponse } from './submission/SubmissionResponse';
 
 export class ExceptionlessClient {
   public config:Configuration;
@@ -108,6 +110,12 @@ export class ExceptionlessClient {
     return new EventBuilder({ date: new Date() }, this, pluginContextData);
   }
 
+  /**
+   * Submits the event to be sent to the server.
+   * @param event The event data.
+   * @param pluginContextData Any contextual data objects to be used by Exceptionless plugins to gather default information for inclusion in the report information.
+   * @param callback
+   */
   public submitEvent(event:IEvent, pluginContextData?:ContextData, callback?:(context:EventPluginContext) => void): void {
     if (!event) {
       return;
@@ -153,6 +161,37 @@ export class ExceptionlessClient {
     });
   }
 
+  /**
+   * Updates the user's email address and description of an event for the specified reference id.
+   * @param referenceId The reference id of the event to update.
+   * @param email The user's email address to set on the event.
+   * @param description The user's description of the event.
+   */
+  public updateUserEmailAndDescription(referenceId:string, email:string, description:string, callback?:(response:SubmissionResponse) => void) {
+    if (!referenceId || !email || !description) {
+      return;
+    }
+
+    if (!this.config.enabled) {
+      return this.config.log.info('Configuration is disabled. The event will not be updated with the user email and description.');
+    }
+
+    var description:IUserDescription = { email: email, description: description };
+    var response = this.config.submissionClient.postUserDescription(referenceId, description, this.config, (response:SubmissionResponse) => {
+      if (!response.success) {
+        this.config.log.error(`Failed to submit user email and description for event '${referenceId}': ${response.statusCode} ${response.message}`)
+      }
+
+      if (!!callback) {
+        callback(response);
+      }
+    });
+  }
+
+  /**
+   * Gets the last event client id that was submitted to the server.
+   * @returns {string} The event client id.
+   */
   public getLastReferenceId(): string {
     return this.config.lastReferenceIdManager.getLast();
   }
diff --git a/src/submission/SubmissionClientBase.ts b/src/submission/SubmissionClientBase.ts
@@ -9,10 +9,11 @@ import { SubmissionResponse } from './SubmissionResponse';
 import { Utils } from '../Utils';
 
 export class SubmissionClientBase implements ISubmissionClient {
+  public configurationVersionHeader:string = 'X-Exceptionless-ConfigVersion';
+
   public postEvents(events:IEvent[], config:Configuration, callback:(response:SubmissionResponse) => void):void {
     return this.sendRequest(config, 'POST', '/api/v2/events', Utils.stringify(events, config.dataExclusions), (status:number, message:string, data?:string, headers?:Object) => {
-
-      var settingsVersion = (headers && parseInt(headers['X-Exceptionless-ConfigVersion'])) || -1;
+      var settingsVersion = (headers && parseInt(headers[this.configurationVersionHeader])) || -1;
       SettingsManager.checkVersion(settingsVersion, config);
 
       callback(new SubmissionResponse(status, message));
@@ -21,7 +22,10 @@ export class SubmissionClientBase implements ISubmissionClient {
 
   public postUserDescription(referenceId:string, description:IUserDescription, config:Configuration, callback:(response:SubmissionResponse) => void):void {
     var path = `/api/v2/events/by-ref/${encodeURIComponent(referenceId)}/user-description`;
-    return this.sendRequest(config, 'POST', path, Utils.stringify(description, config.dataExclusions), (status:number, message:string) => {
+    return this.sendRequest(config, 'POST', path, Utils.stringify(description, config.dataExclusions), (status:number, message:string, data?:string, headers?:Object) => {
+      var settingsVersion = (headers && parseInt(headers[this.configurationVersionHeader])) || -1;
+      SettingsManager.checkVersion(settingsVersion, config);
+
       callback(new SubmissionResponse(status, message));
     });
   }
