/core/externals/update-engine/externals/gdata-objectivec-client/Source/Networking/GDataAuthenticationFetcher.h
http://macfuse.googlecode.com/ · C++ Header · 66 lines · 11 code · 5 blank · 50 comment · 0 complexity · 283d9fcfe776785bce60bc0d88ad89ef MD5 · raw file
- /* Copyright (c) 2009 Google Inc.
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- //
- // GDataAuthenticationFetcher.h
- //
- #import "GTMHTTPFetcher.h"
- @interface GDataAuthenticationFetcher : NSObject
- // authTokenFetcherWithUsername: returns a GDataHTTPFetcher for obtaining a
- // response with Google's ClientLogin protocol
- //
- // Protocol docs: http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html
- //
- // serviceID is the code for the service to be used, such as
- // [GDataServiceGoogleCalendar serviceID]
- // source is the app's identifier, in the form companyName-applicationName-versionID
- // domain should be nil to authenticate against www.google.com; it may be
- // localhost:n for unit testing to port n
- // params is a dictionary with additional parameters for the post body
- // headers are custom headers to be added to the request; typically this is nil
- //
- // The params dictionary may be used to specify a captcha response, as in
- // NSDictionary *params = nil;
- // if ([captchaToken length] > 0 && [captchaAnswer length] > 0) {
- // params = [NSDictionary dictionaryWithObjectsAndKeys:
- // captchaToken, @"logintoken",
- // captchaAnswer, @"logincaptcha", nil];
- // }
- //
- // The user should invoke the fetcher's beginFetchWithDelegate: method
- // and provide the callbacks, consistent with the GDataHTTPFetcher
- // conventions.
- //
- // The callback data may be parsed with +dictionaryWithResponseData
- // from GDataUtilities, as in
- //
- // - (void)authFetcher:(GTMHTTPFetcher *)fetcher finishedWithData:(NSData *)data error:(NSError *)error {
- // if (error == nil) {
- // NSDictionary *responseDict = [GDataUtilities dictionaryWithResponseData:data];
- // ...
- //
- + (GTMHTTPFetcher *)authTokenFetcherWithUsername:(NSString *)username
- password:(NSString *)password
- service:(NSString *)serviceID
- source:(NSString *)source
- signInDomain:(NSString *)domain
- accountType:(NSString *)accountType
- additionalParameters:(NSDictionary *)params
- customHeaders:(NSDictionary *)headers;
- @end