cherry-pick: Added some comments to the manual to explain the addition of the data argument to the loginConfirmed method

julianjelfs · witoldsz · commit 28d0b4011cd4 · 2013-03-31T14:06:27.000+02:00
Conflicts:
	src/angular-http-auth.js
diff --git a/README.md b/README.md
@@ -21,8 +21,11 @@ of every HTTP 401 response is buffered and everytime it happens, the
 'event:auth-loginRequired' message is broadcasted from $rootScope.
 
 The 'authService' has only one method: #loginConfirmed().
-You are responsible to invoke this method after user logged in.
-It will retry all the requests previously failed due to HTTP 401 response.
+You are responsible to invoke this method after user logged in. You may optionally pass in 
+a data argument to the loginConfirmed method which will be passed on to the loginConfirmed
+$broadcast. This may be useful, for example if you need to pass through details of the user 
+that was logged in. The 'authService' will then retry all the requests previously failed due 
+to HTTP 401 response.
 
 ###Typical use case:
 
diff --git a/src/http-auth-interceptor.js b/src/http-auth-interceptor.js
@@ -12,6 +12,12 @@
 
   .factory('authService', ['$rootScope','httpBuffer', function($rootScope, httpBuffer) {
     return {
+      /**
+       * call this function to indicate that authentication was successfull and trigger a 
+       * retry of all deferred requests.
+       * @param data an optional argument to pass on to $broadcast which may be useful for
+       * example if you need to pass through details of the user that was logged in
+       */
       loginConfirmed: function(data) {
         $rootScope.$broadcast('event:auth-loginConfirmed', data);
         httpBuffer.retryAll();
