App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | List of all members
google.appengine.api.users.User Class Reference
Inheritance diagram for google.appengine.api.users.User:

Public Member Functions

def __init__
 
def nickname
 
def email
 
def user_id
 
def auth_domain
 
def federated_identity
 
def federated_provider
 
def __unicode__
 
def __str__
 
def __repr__
 
def __hash__
 
def __cmp__
 

Detailed Description

A user.

We provide the email address, nickname, and id for a user.

A nickname is a human-readable string which uniquely identifies a Google
user, akin to a username. It will be an email address for some users, but
not all.

A user could be a Google Accounts user or a federated login user.

federated_identity and federated_provider are only avaliable for
federated users.

Constructor & Destructor Documentation

def google.appengine.api.users.User.__init__ (   self,
  email = None,
  _auth_domain = None,
  _user_id = None,
  federated_identity = None,
  federated_provider = None,
  _strict_mode = True 
)
Constructor.

Args:
  email: An optional string of the user's email address. It defaults to
  the current user's email address.
  federated_identity: federated identity of user. It defaults to the current
  user's federated identity.
  federated_provider: federated provider url of user.

Raises:
  UserNotFoundError: Raised if the user is not logged in and both email
  and federated identity are empty.

Member Function Documentation

def google.appengine.api.users.User.auth_domain (   self)
Return this user's auth domain.

This method is internal and should not be used by client applications.
def google.appengine.api.users.User.email (   self)
Return this user's email address.
def google.appengine.api.users.User.federated_identity (   self)
Return this user's federated identity, None if not a federated user.
def google.appengine.api.users.User.federated_provider (   self)
Return this user's federated provider, None if not a federated user.
def google.appengine.api.users.User.nickname (   self)
Return this user's nickname.

The nickname will be a unique, human readable identifier for this user
with respect to this application. It will be an email address for some
users, part of the email address for some users, and the federated identity
for federated users who have not asserted an email address.
def google.appengine.api.users.User.user_id (   self)
Return either a permanent unique identifying string or None.

If the email address was set explicity, this will return None.

The documentation for this class was generated from the following file: