Class Index | File Index

Classes


Class com.gContactSync.LoginManager


Defined in: LoginManager.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Stores and retrieves the authentication token from the login manager.
Field Summary
Field Attributes Field Name and Description
<static>  
com.gContactSync.LoginManager.mAuthTokens
An object with authentication tokens keyed by username
<static>  
com.gContactSync.LoginManager.mHostname
The hostname used in the login manager
<static>  
com.gContactSync.LoginManager.mHttpRealm
The HTTP realm
<static>  
com.gContactSync.LoginManager.mNumAuthTokens
The number of authentication tokens found
<static>  
com.gContactSync.LoginManager.mPasswordField
The password field
<static>  
com.gContactSync.LoginManager.mSubmitURL
The URL in the login manager
<static>  
com.gContactSync.LoginManager.mUsernameField
The username field
Method Summary
Method Attributes Method Name and Description
<static>  
com.gContactSync.LoginManager.addAuthToken(aUsername, aToken)
Stores the token in the Login Manager.
<static>  
com.gContactSync.LoginManager.getAllEmailAccts(aPattern)
Returns an array of all e-mail account usernames matching an optional pattern.
<static>  
com.gContactSync.LoginManager.getAuthToken(aUsername)
Gets the token in the Login Manager.
<static>  
com.gContactSync.LoginManager.getAuthTokens()
Gets the tokens in the Login Manager.
<static>  
com.gContactSync.LoginManager.removeAuthToken(aUsername)
Removes the auth token from the Login Manager.
Class Detail
com.gContactSync.LoginManager()
Stores and retrieves the authentication token from the login manager. Does NOT store the password and username.
Field Detail
<static> com.gContactSync.LoginManager.mAuthTokens
An object with authentication tokens keyed by username

<static> com.gContactSync.LoginManager.mHostname
The hostname used in the login manager

<static> com.gContactSync.LoginManager.mHttpRealm
The HTTP realm

<static> com.gContactSync.LoginManager.mNumAuthTokens
The number of authentication tokens found

<static> com.gContactSync.LoginManager.mPasswordField
The password field

<static> com.gContactSync.LoginManager.mSubmitURL
The URL in the login manager

<static> com.gContactSync.LoginManager.mUsernameField
The username field
Method Detail
<static> com.gContactSync.LoginManager.addAuthToken(aUsername, aToken)
Stores the token in the Login Manager.
Parameters:
aUsername
{string} The username (e-mail address).
aToken
{string} The authentication token from Google.

<static> com.gContactSync.LoginManager.getAllEmailAccts(aPattern)
Returns an array of all e-mail account usernames matching an optional pattern.
Parameters:
aPattern
{RegExp} A RegExp to match against. If not provided all IMAP & mailbox usernames are returned.

<static> {string} com.gContactSync.LoginManager.getAuthToken(aUsername)
Gets the token in the Login Manager.
Parameters:
aUsername
Returns:
{string} The auth token, if present, null otherwise.

<static> {object} com.gContactSync.LoginManager.getAuthTokens()
Gets the tokens in the Login Manager.
Returns:
{object} The auth tokens, if any, null otherwise.

<static> {boolean} com.gContactSync.LoginManager.removeAuthToken(aUsername)
Removes the auth token from the Login Manager.
Parameters:
aUsername
Returns:
{boolean} True if the auth token was successfully removed.

Documentation generated by JsDoc Toolkit 2.1.0 on Fri May 06 2011 09:24:18 GMT-0400 (EDT)