circuit
circuit social network code-documentation
Public Member Functions | Static Public Attributes | List of all members
users.models.User Class Reference

Inherits AbstractBaseUser.

Public Member Functions

def gravatar_hash (self)
 
def get_circles (self)
 
def get_full_name (self)
 
def get_short_name (self)
 
def __str__ (self)
 
def has_perm (self, perm_str)
 
def has_module_perms (self, module_label)
 

Static Public Attributes

tuple username = models.CharField(unique=True, max_length=32)
 
tuple email = models.EmailField(unique=True)
 
tuple name = models.CharField(max_length=50, default='', blank=True)
 
tuple description = models.TextField(default='', blank=True)
 
tuple is_active = models.BooleanField(default=False)
 
tuple confirm_token = models.CharField(default=create_hash, max_length=40)
 
tuple password_reset_token = models.CharField(default=create_hash, max_length=40)
 
tuple created_at = models.DateTimeField(auto_now_add=True)
 
tuple updated_at = models.DateTimeField(auto_now=True)
 
tuple is_staff = models.BooleanField(default=False)
 
tuple is_superuser = models.BooleanField(default=False)
 
string USERNAME_FIELD = 'email'
 
list REQUIRED_FIELDS = ['username']
 
tuple objects = UserManager()
 

Detailed Description

The circuit User model

Member Function Documentation

def users.models.User.__str__ (   self)
def users.models.User.get_circles (   self)
the circles created by the user

@return: list of Circle instances
def users.models.User.get_full_name (   self)
Alias for get_name
@return: string - returns the name
def users.models.User.get_short_name (   self)
Alias for get_name
@return: string - returns the name
def users.models.User.gravatar_hash (   self)
def users.models.User.has_module_perms (   self,
  module_label 
)
Needed for using Django's admin panel.
def users.models.User.has_perm (   self,
  perm_str 
)
Needed for using Django's admin panel.

Member Data Documentation

tuple users.models.User.confirm_token = models.CharField(default=create_hash, max_length=40)
static
tuple users.models.User.created_at = models.DateTimeField(auto_now_add=True)
static
tuple users.models.User.description = models.TextField(default='', blank=True)
static
tuple users.models.User.email = models.EmailField(unique=True)
static
tuple users.models.User.is_active = models.BooleanField(default=False)
static
tuple users.models.User.is_staff = models.BooleanField(default=False)
static
tuple users.models.User.is_superuser = models.BooleanField(default=False)
static
tuple users.models.User.name = models.CharField(max_length=50, default='', blank=True)
static
tuple users.models.User.objects = UserManager()
static
tuple users.models.User.password_reset_token = models.CharField(default=create_hash, max_length=40)
static
list users.models.User.REQUIRED_FIELDS = ['username']
static
tuple users.models.User.updated_at = models.DateTimeField(auto_now=True)
static
tuple users.models.User.username = models.CharField(unique=True, max_length=32)
static
string users.models.User.USERNAME_FIELD = 'email'
static

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