|  | Method resolution order:MapsClientgdata.client.GDClientatom.client.AtomPubClient__builtin__.object
 Methods defined here:
 
 AddFeature = add_feature(self, map_id, title, content, auth_token=None, title_type='text', content_type='application/vnd.google-earth.kml+xml', **kwargs)
 CreateMap = create_map(self, title, summary=None, unlisted=False, auth_token=None, title_type='text', summary_type='text', **kwargs)
 Delete = delete(self, entry_or_uri, auth_token=None, **kwargs)
 GetFeatures = get_features(self, map_id, user_id='default', auth_token=None, desired_class=<class 'gdata.maps.data.FeatureFeed'>, query=None, **kwargs)
 GetMaps = get_maps(self, user_id='default', auth_token=None, desired_class=<class 'gdata.maps.data.MapFeed'>, **kwargs)
 Update = update(self, entry, auth_token=None, **kwargs)
 add_feature(self, map_id, title, content, auth_token=None, title_type='text', content_type='application/vnd.google-earth.kml+xml', **kwargs)Adds a new feature to the given map.
 Args:
 map_id: A string representing the ID of the map to which the new feature
 should be added.
 title: A string representing the name/title of the new feature.
 content: A KML string or gdata.maps.data.KmlContent object representing
 the new feature's KML contents, including its description.
 
 Returns:
 A gdata.maps.data.Feature.
 create_map(self, title, summary=None, unlisted=False, auth_token=None, title_type='text', summary_type='text', **kwargs)Creates a new map and posts it to the Maps Data servers.
 Args:
 title: A string representing the title of the new map.
 summary: An optional string representing the new map's description.
 unlisted: An optional boolean identifying whether the map should be
 unlisted (True) or public (False). Default False.
 
 Returns:
 A gdata.maps.data.Map.
 delete(self, entry_or_uri, auth_token=None, **kwargs)Deletes the given entry or entry URI server-side.
 Args:
 entry_or_uri: A gdata.maps.data.Map, gdata.maps.data.Feature, or URI
 string representing the entry to delete.
 get_features(self, map_id, user_id='default', auth_token=None, desired_class=<class 'gdata.maps.data.FeatureFeed'>, query=None, **kwargs)Retrieves a Feature feed for the given map ID/user ID combination.
 Args:
 map_id: A string representing the ID of the map whose features should be
 retrieved.
 user_id: An optional string representing the user ID; should be 'default'.
 
 Returns:
 A gdata.maps.data.FeatureFeed.
 get_maps(self, user_id='default', auth_token=None, desired_class=<class 'gdata.maps.data.MapFeed'>, **kwargs)Retrieves a Map feed for the given user ID.
 Args:
 user_id: An optional string representing the user ID; should be 'default'.
 
 Returns:
 A gdata.maps.data.MapFeed.
 update(self, entry, auth_token=None, **kwargs)Sends changes to a given map or feature entry to the Maps Data servers.
 Args:
 entry: A gdata.maps.data.Map or gdata.maps.data.Feature to be updated
 server-side.
 Data and other attributes defined here:
 
 api_version = '2'
 auth_scopes = ('http://maps.google.com/maps/feeds/',)
 auth_service = 'local'
 Methods inherited from gdata.client.GDClient:
 
 ClientLogin = client_login(self, email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object>, captcha_token=None, captcha_response=None)Performs an auth request using the user's email address and password.
 In order to modify user specific data and read user private data, your
 application must be authorized by the user. One way to demonstrage
 authorization is by including a Client Login token in the Authorization
 HTTP header of all requests. This method requests the Client Login token
 by sending the user's email address, password, the name of the
 application, and the service code for the service which will be accessed
 by the application. If the username and password are correct, the server
 will respond with the client login code and a new ClientLoginToken
 object will be set in the client's auth_token member. With the auth_token
 set, future requests from this client will include the Client Login
 token.
 
 For a list of service names, see
 http://code.google.com/apis/gdata/faq.html#clientlogin
 For more information on Client Login, see:
 http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html
 
 Args:
 email: str The user's email address or username.
 password: str The password for the user's account.
 source: str The name of your application. This can be anything you
 like but should should give some indication of which app is
 making the request.
 service: str The service code for the service you would like to access.
 For example, 'cp' for contacts, 'cl' for calendar. For a full
 list see
 http://code.google.com/apis/gdata/faq.html#clientlogin
 If you are using a subclass of the gdata.client.GDClient, the
 service will usually be filled in for you so you do not need
 to specify it. For example see BloggerClient,
 SpreadsheetsClient, etc.
 account_type: str (optional) The type of account which is being
 authenticated. This can be either 'GOOGLE' for a Google
 Account, 'HOSTED' for a Google Apps Account, or the
 default 'HOSTED_OR_GOOGLE' which will select the Google
 Apps Account if the same email address is used for both
 a Google Account and a Google Apps Account.
 auth_url: str (optional) The URL to which the login request should be
 sent.
 captcha_token: str (optional) If a previous login attempt was reponded
 to with a CAPTCHA challenge, this is the token which
 identifies the challenge (from the CAPTCHA's URL).
 captcha_response: str (optional) If a previous login attempt was
 reponded to with a CAPTCHA challenge, this is the
 response text which was contained in the challenge.
 
 Returns:
 None
 
 Raises:
 A RequestError or one of its suclasses: BadAuthentication,
 BadAuthenticationServiceURL, ClientLoginFailed,
 ClientLoginTokenMissing, or CaptchaChallenge
 GetAccessToken = get_access_token(self, request_token, url='https://www.google.com/accounts/OAuthGetAccessToken')Exchanges an authorized OAuth request token for an access token.
 Contacts the Google OAuth server to upgrade a previously authorized
 request token. Once the request token is upgraded to an access token,
 the access token may be used to access the user's data.
 
 For more details, see the Google Accounts OAuth documentation:
 http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken
 
 Args:
 request_token: An OAuth token which has been authorized by the user.
 url: (optional) The URL to which the upgrade request should be sent.
 Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken
 GetEntry = get_entry(self, uri, auth_token=None, converter=None, desired_class=<class 'gdata.data.GDEntry'>, etag=None, **kwargs)
 GetFeed = get_feed(self, uri, auth_token=None, converter=None, desired_class=<class 'gdata.data.GDFeed'>, **kwargs)
 GetNext = get_next(self, feed, auth_token=None, converter=None, desired_class=None, **kwargs)Fetches the next set of results from the feed.
 When requesting a feed, the number of entries returned is capped at a
 service specific default limit (often 25 entries). You can specify your
 own entry-count cap using the max-results URL query parameter. If there
 are more results than could fit under max-results, the feed will contain
 a next link. This method performs a GET against this next results URL.
 
 Returns:
 A new feed object containing the next set of entries in this feed.
 GetOAuthToken = get_oauth_token(self, scopes, next, consumer_key, consumer_secret=None, rsa_private_key=None, url='https://www.google.com/accounts/OAuthGetRequestToken')Obtains an OAuth request token to allow the user to authorize this app.
 Once this client has a request token, the user can authorize the request
 token by visiting the authorization URL in their browser. After being
 redirected back to this app at the 'next' URL, this app can then exchange
 the authorized request token for an access token.
 
 For more information see the documentation on Google Accounts with OAuth:
 http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess
 
 Args:
 scopes: list of strings or atom.http_core.Uri objects which specify the
 URL prefixes which this app will be accessing. For example, to access
 the Google Calendar API, you would want to use scopes:
 ['https://www.google.com/calendar/feeds/',
 'http://www.google.com/calendar/feeds/']
 next: str or atom.http_core.Uri object, The URL which the user's browser
 should be sent to after they authorize access to their data. This
 should be a URL in your application which will read the token
 information from the URL and upgrade the request token to an access
 token.
 consumer_key: str This is the identifier for this application which you
 should have received when you registered your application with Google
 to use OAuth.
 consumer_secret: str (optional) The shared secret between your app and
 Google which provides evidence that this request is coming from you
 application and not another app. If present, this libraries assumes
 you want to use an HMAC signature to verify requests. Keep this data
 a secret.
 rsa_private_key: str (optional) The RSA private key which is used to
 generate a digital signature which is checked by Google's server. If
 present, this library assumes that you want to use an RSA signature
 to verify requests. Keep this data a secret.
 url: The URL to which a request for a token should be made. The default
 is Google's OAuth request token provider.
 ModifyRequest = modify_request(self, http_request)Adds or changes request before making the HTTP request.
 This client will add the API version if it is specified.
 Subclasses may override this method to add their own request
 modifications before the request is made.
 Post = post(self, entry, uri, auth_token=None, converter=None, desired_class=None, **kwargs)
 Request = request(self, method=None, uri=None, auth_token=None, http_request=None, converter=None, desired_class=None, redirects_remaining=4, **kwargs)Make an HTTP request to the server.
 See also documentation for atom.client.AtomPubClient.request.
 
 If a 302 redirect is sent from the server to the client, this client
 assumes that the redirect is in the form used by the Google Calendar API.
 The same request URI and method will be used as in the original request,
 but a gsessionid URL parameter will be added to the request URI with
 the value provided in the server's 302 redirect response. If the 302
 redirect is not in the format specified by the Google Calendar API, a
 RedirectError will be raised containing the body of the server's
 response.
 
 The method calls the client's modify_request method to make any changes
 required by the client before the request is made. For example, a
 version 2 client could add a GData-Version: 2 header to the request in
 its modify_request method.
 
 Args:
 method: str The HTTP verb for this request, usually 'GET', 'POST',
 'PUT', or 'DELETE'
 uri: atom.http_core.Uri, str, or unicode The URL being requested.
 auth_token: An object which sets the Authorization HTTP header in its
 modify_request method. Recommended classes include
 gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken
 among others.
 http_request: (optional) atom.http_core.HttpRequest
 converter: function which takes the body of the response as it's only
 argument and returns the desired object.
 desired_class: class descended from atom.core.XmlElement to which a
 successful response should be converted. If there is no
 converter function specified (converter=None) then the
 desired_class will be used in calling the
 atom.core.parse function. If neither
 the desired_class nor the converter is specified, an
 HTTP reponse object will be returned.
 redirects_remaining: (optional) int, if this number is 0 and the
 server sends a 302 redirect, the request method
 will raise an exception. This parameter is used in
 recursive request calls to avoid an infinite loop.
 
 Any additional arguments are passed through to
 atom.client.AtomPubClient.request.
 
 Returns:
 An HTTP response object (see atom.http_core.HttpResponse for a
 description of the object's interface) if no converter was
 specified and no desired_class was specified. If a converter function
 was provided, the results of calling the converter are returned. If no
 converter was specified but a desired_class was provided, the response
 body will be converted to the class using
 atom.core.parse.
 RequestClientLoginToken = request_client_login_token(self, email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object>, captcha_token=None, captcha_response=None)
 RevokeToken = revoke_token(self, token=None, url=<atom.http_core.Uri object>)Requests that the token be invalidated.
 This method can be used for both AuthSub and OAuth tokens (to invalidate
 a ClientLogin token, the user must change their password).
 
 Returns:
 True if the server responded with a 200.
 
 Raises:
 A RequestError if the server responds with a non-200 status.
 UpgradeToken = upgrade_token(self, token=None, url=<atom.http_core.Uri object>)Asks the Google auth server for a multi-use AuthSub token.
 For details on AuthSub, see:
 http://code.google.com/apis/accounts/docs/AuthSub.html
 
 Args:
 token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken
 (optional) If no token is passed in, the client's auth_token member
 is used to request the new token. The token object will be modified
 to contain the new session token string.
 url: str or atom.http_core.Uri (optional) The URL to which the token
 upgrade request should be sent. Defaults to:
 https://www.google.com/accounts/AuthSubSessionToken
 
 Returns:
 The upgraded gdata.gauth.AuthSubToken object.
 client_login(self, email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object>, captcha_token=None, captcha_response=None)Performs an auth request using the user's email address and password.
 In order to modify user specific data and read user private data, your
 application must be authorized by the user. One way to demonstrage
 authorization is by including a Client Login token in the Authorization
 HTTP header of all requests. This method requests the Client Login token
 by sending the user's email address, password, the name of the
 application, and the service code for the service which will be accessed
 by the application. If the username and password are correct, the server
 will respond with the client login code and a new ClientLoginToken
 object will be set in the client's auth_token member. With the auth_token
 set, future requests from this client will include the Client Login
 token.
 
 For a list of service names, see
 http://code.google.com/apis/gdata/faq.html#clientlogin
 For more information on Client Login, see:
 http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html
 
 Args:
 email: str The user's email address or username.
 password: str The password for the user's account.
 source: str The name of your application. This can be anything you
 like but should should give some indication of which app is
 making the request.
 service: str The service code for the service you would like to access.
 For example, 'cp' for contacts, 'cl' for calendar. For a full
 list see
 http://code.google.com/apis/gdata/faq.html#clientlogin
 If you are using a subclass of the gdata.client.GDClient, the
 service will usually be filled in for you so you do not need
 to specify it. For example see BloggerClient,
 SpreadsheetsClient, etc.
 account_type: str (optional) The type of account which is being
 authenticated. This can be either 'GOOGLE' for a Google
 Account, 'HOSTED' for a Google Apps Account, or the
 default 'HOSTED_OR_GOOGLE' which will select the Google
 Apps Account if the same email address is used for both
 a Google Account and a Google Apps Account.
 auth_url: str (optional) The URL to which the login request should be
 sent.
 captcha_token: str (optional) If a previous login attempt was reponded
 to with a CAPTCHA challenge, this is the token which
 identifies the challenge (from the CAPTCHA's URL).
 captcha_response: str (optional) If a previous login attempt was
 reponded to with a CAPTCHA challenge, this is the
 response text which was contained in the challenge.
 
 Returns:
 None
 
 Raises:
 A RequestError or one of its suclasses: BadAuthentication,
 BadAuthenticationServiceURL, ClientLoginFailed,
 ClientLoginTokenMissing, or CaptchaChallenge
 get_access_token(self, request_token, url='https://www.google.com/accounts/OAuthGetAccessToken')Exchanges an authorized OAuth request token for an access token.
 Contacts the Google OAuth server to upgrade a previously authorized
 request token. Once the request token is upgraded to an access token,
 the access token may be used to access the user's data.
 
 For more details, see the Google Accounts OAuth documentation:
 http://code.google.com/apis/accounts/docs/OAuth.html#AccessToken
 
 Args:
 request_token: An OAuth token which has been authorized by the user.
 url: (optional) The URL to which the upgrade request should be sent.
 Defaults to: https://www.google.com/accounts/OAuthAuthorizeToken
 get_entry(self, uri, auth_token=None, converter=None, desired_class=<class 'gdata.data.GDEntry'>, etag=None, **kwargs)
 get_feed(self, uri, auth_token=None, converter=None, desired_class=<class 'gdata.data.GDFeed'>, **kwargs)
 get_next(self, feed, auth_token=None, converter=None, desired_class=None, **kwargs)Fetches the next set of results from the feed.
 When requesting a feed, the number of entries returned is capped at a
 service specific default limit (often 25 entries). You can specify your
 own entry-count cap using the max-results URL query parameter. If there
 are more results than could fit under max-results, the feed will contain
 a next link. This method performs a GET against this next results URL.
 
 Returns:
 A new feed object containing the next set of entries in this feed.
 get_oauth_token(self, scopes, next, consumer_key, consumer_secret=None, rsa_private_key=None, url='https://www.google.com/accounts/OAuthGetRequestToken')Obtains an OAuth request token to allow the user to authorize this app.
 Once this client has a request token, the user can authorize the request
 token by visiting the authorization URL in their browser. After being
 redirected back to this app at the 'next' URL, this app can then exchange
 the authorized request token for an access token.
 
 For more information see the documentation on Google Accounts with OAuth:
 http://code.google.com/apis/accounts/docs/OAuth.html#AuthProcess
 
 Args:
 scopes: list of strings or atom.http_core.Uri objects which specify the
 URL prefixes which this app will be accessing. For example, to access
 the Google Calendar API, you would want to use scopes:
 ['https://www.google.com/calendar/feeds/',
 'http://www.google.com/calendar/feeds/']
 next: str or atom.http_core.Uri object, The URL which the user's browser
 should be sent to after they authorize access to their data. This
 should be a URL in your application which will read the token
 information from the URL and upgrade the request token to an access
 token.
 consumer_key: str This is the identifier for this application which you
 should have received when you registered your application with Google
 to use OAuth.
 consumer_secret: str (optional) The shared secret between your app and
 Google which provides evidence that this request is coming from you
 application and not another app. If present, this libraries assumes
 you want to use an HMAC signature to verify requests. Keep this data
 a secret.
 rsa_private_key: str (optional) The RSA private key which is used to
 generate a digital signature which is checked by Google's server. If
 present, this library assumes that you want to use an RSA signature
 to verify requests. Keep this data a secret.
 url: The URL to which a request for a token should be made. The default
 is Google's OAuth request token provider.
 modify_request(self, http_request)Adds or changes request before making the HTTP request.
 This client will add the API version if it is specified.
 Subclasses may override this method to add their own request
 modifications before the request is made.
 post(self, entry, uri, auth_token=None, converter=None, desired_class=None, **kwargs)
 request(self, method=None, uri=None, auth_token=None, http_request=None, converter=None, desired_class=None, redirects_remaining=4, **kwargs)Make an HTTP request to the server.
 See also documentation for atom.client.AtomPubClient.request.
 
 If a 302 redirect is sent from the server to the client, this client
 assumes that the redirect is in the form used by the Google Calendar API.
 The same request URI and method will be used as in the original request,
 but a gsessionid URL parameter will be added to the request URI with
 the value provided in the server's 302 redirect response. If the 302
 redirect is not in the format specified by the Google Calendar API, a
 RedirectError will be raised containing the body of the server's
 response.
 
 The method calls the client's modify_request method to make any changes
 required by the client before the request is made. For example, a
 version 2 client could add a GData-Version: 2 header to the request in
 its modify_request method.
 
 Args:
 method: str The HTTP verb for this request, usually 'GET', 'POST',
 'PUT', or 'DELETE'
 uri: atom.http_core.Uri, str, or unicode The URL being requested.
 auth_token: An object which sets the Authorization HTTP header in its
 modify_request method. Recommended classes include
 gdata.gauth.ClientLoginToken and gdata.gauth.AuthSubToken
 among others.
 http_request: (optional) atom.http_core.HttpRequest
 converter: function which takes the body of the response as it's only
 argument and returns the desired object.
 desired_class: class descended from atom.core.XmlElement to which a
 successful response should be converted. If there is no
 converter function specified (converter=None) then the
 desired_class will be used in calling the
 atom.core.parse function. If neither
 the desired_class nor the converter is specified, an
 HTTP reponse object will be returned.
 redirects_remaining: (optional) int, if this number is 0 and the
 server sends a 302 redirect, the request method
 will raise an exception. This parameter is used in
 recursive request calls to avoid an infinite loop.
 
 Any additional arguments are passed through to
 atom.client.AtomPubClient.request.
 
 Returns:
 An HTTP response object (see atom.http_core.HttpResponse for a
 description of the object's interface) if no converter was
 specified and no desired_class was specified. If a converter function
 was provided, the results of calling the converter are returned. If no
 converter was specified but a desired_class was provided, the response
 body will be converted to the class using
 atom.core.parse.
 request_client_login_token(self, email, password, source, service=None, account_type='HOSTED_OR_GOOGLE', auth_url=<atom.http_core.Uri object>, captcha_token=None, captcha_response=None)
 revoke_token(self, token=None, url=<atom.http_core.Uri object>)Requests that the token be invalidated.
 This method can be used for both AuthSub and OAuth tokens (to invalidate
 a ClientLogin token, the user must change their password).
 
 Returns:
 True if the server responded with a 200.
 
 Raises:
 A RequestError if the server responds with a non-200 status.
 upgrade_token(self, token=None, url=<atom.http_core.Uri object>)Asks the Google auth server for a multi-use AuthSub token.
 For details on AuthSub, see:
 http://code.google.com/apis/accounts/docs/AuthSub.html
 
 Args:
 token: gdata.gauth.AuthSubToken or gdata.gauth.SecureAuthSubToken
 (optional) If no token is passed in, the client's auth_token member
 is used to request the new token. The token object will be modified
 to contain the new session token string.
 url: str or atom.http_core.Uri (optional) The URL to which the token
 upgrade request should be sent. Defaults to:
 https://www.google.com/accounts/AuthSubSessionToken
 
 Returns:
 The upgraded gdata.gauth.AuthSubToken object.
 Methods inherited from atom.client.AtomPubClient:
 
 Get = get(self, uri=None, auth_token=None, http_request=None, **kwargs)Performs a request using the GET method, returns an HTTP response.
 Put = put(self, uri=None, data=None, auth_token=None, http_request=None, **kwargs)Sends data using the PUT method, returns an HTTP response.
 __init__(self, http_client=None, host=None, auth_token=None, source=None, **kwargs)Creates a new AtomPubClient instance.
 Args:
 source: The name of your application.
 http_client: An object capable of performing HTTP requests through a
 request method. This object is used to perform the request
 when the AtomPubClient's request method is called. Used to
 allow HTTP requests to be directed to a mock server, or use
 an alternate library instead of the default of httplib to
 make HTTP requests.
 host: str The default host name to use if a host is not specified in the
 requested URI.
 auth_token: An object which sets the HTTP Authorization header when its
 modify_request method is called.
 get(self, uri=None, auth_token=None, http_request=None, **kwargs)Performs a request using the GET method, returns an HTTP response.
 put(self, uri=None, data=None, auth_token=None, http_request=None, **kwargs)Sends data using the PUT method, returns an HTTP response.
 Data descriptors inherited from atom.client.AtomPubClient:
 
 __dict__dictionary for instance variables (if defined)
 __weakref__list of weak references to the object (if defined)
 Data and other attributes inherited from atom.client.AtomPubClient:
 
 auth_token = None
 host = None
 ssl = False
 |