TOXYGEN
 All Classes Functions
Public Member Functions | Public Attributes | Properties | List of all members
src.profile.Profile Class Reference
Inheritance diagram for src.profile.Profile:
src.profile.Contact

Public Member Functions

def __init__
 
def change_status
 
def set_name
 
def set_status_message
 
def filtration
 
def update_filtration
 
def get_friend_by_number
 
def get_active
 
def set_active
 
def get_active_number
 
def get_active_name
 
def is_active_online
 
def split_and_send
 
def new_message
 
def send_message
 
def save_history
 
def clear_history
 
def export_history
 
def create_friend_item
 
def create_message_item
 
def set_alias
 
def friend_public_key
 
def delete_friend
 
def send_friend_request
 
def process_friend_request
 
def reset
 
- Public Member Functions inherited from src.profile.Contact
def __init__
 
def get_name
 
def set_name
 
def get_status_message
 
def set_status_message
 
def get_status
 
def set_status
 
def get_tox_id
 
def load_avatar
 
def reset_avatar
 
def set_avatar
 

Public Attributes

 status
 

Properties

 active_friend = property(get_active, set_active)
 
- Properties inherited from src.profile.Contact
 name = property(get_name, set_name)
 
 status_message = property(get_status_message, set_status_message)
 
 status = property(get_status, set_status)
 
 tox_id = property(get_tox_id)
 

Detailed Description

Profile of current toxygen user. Contains friends list, tox instance

Constructor & Destructor Documentation

def src.profile.Profile.__init__ (   self,
  tox,
  screen 
)
:param tox: tox instance
:param screen: ref to main screen

Member Function Documentation

def src.profile.Profile.change_status (   self)
Changes status of user (online, away, busy)
def src.profile.Profile.create_friend_item (   self)
Method-factory
:return: new widget for friend instance
def src.profile.Profile.delete_friend (   self,
  num 
)
Removes friend from contact list
:param num: number of friend in list
def src.profile.Profile.filtration (   self,
  show_online = True,
  filter_str = '' 
)
Filtration of friends list
:param show_online: show online only contacts
:param filter_str: show contacts which name contains this substring
def src.profile.Profile.new_message (   self,
  friend_num,
  message_type,
  message 
)
Current user gets new message
:param friend_num: friend_num of friend who sent message
:param message_type: message type - plain text or action message (/me)
:param message: text of message
def src.profile.Profile.process_friend_request (   self,
  tox_id,
  message 
)
Accept or ignore friend request
:param tox_id: tox id of contact
:param message: message
def src.profile.Profile.reset (   self,
  restart 
)
Recreate tox instance
:param restart: method which calls restart and returns new tox instance
def src.profile.Profile.save_history (   self)
Save history to db
def src.profile.Profile.send_friend_request (   self,
  tox_id,
  message 
)
Function tries to send request to contact with specified id
:param tox_id: id of new contact or tox dns 4 value
:param message: additional message
:return: True on success else error string
def src.profile.Profile.send_message (   self,
  text 
)
Send message to active friend
:param text: message text
def src.profile.Profile.set_active (   self,
  value = None 
)
:param value: number of new active friend in friend's list or None to update active user's data
def src.profile.Profile.split_and_send (   self,
  number,
  message_type,
  message 
)
Message splitting
:param number: friend's number
:param message_type: type of message
:param message: message text
def src.profile.Profile.update_filtration (   self)
Update list of contacts when 1 of friends change connection status

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