Skip to content

Commit

Permalink
few comments
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolascormier committed Sep 28, 2010
1 parent eb6afac commit 9fee577
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions ZTProxy.h
Expand Up @@ -14,14 +14,25 @@
@interface ZTProxy : NSObject {
}

// defaultProxy
// returns an app-wide global proxy object
+ (ZTProxy*) defaultProxy;

// proxyWithAPIKey
// create a new proxy object with a provided api key
// object has been auto-released prior return
+ (id) proxyWithAPIKey:(NSString*)apiKey;

// proxyWithAPIKey
// create a new proxy object with a provided api key
- (id) initWithAPIKey:(NSString*)apiKey;

- (void) useCache:(BOOL)enableCache; // default YES

- (void) doNotUseCredential; // default mode
// doNotUseCredential
// prevent ZTProxy from using a credential when querying zootool's server
// this is the default mode
- (void) doNotUseCredential;

// useCredential
// set a credential to be used when querying zootool's server
Expand All @@ -35,7 +46,9 @@
// once again no validation here
// you should call validateCredentialAgainstServer after this call
- (BOOL) tryToReuseCredentialForUsername:(NSString*)username;


// validateCredentialAgainstServer
// returns YES if the credential provided are valid
- (BOOL) validateCredentialAgainstServer;

- (ZTUser*) userWithUsername:(NSString*)username;
Expand Down

0 comments on commit 9fee577

Please sign in to comment.