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

Public Member Functions

def __init__
 
def change_status
 
def set_status
 
def set_name
 
def set_status_message
 
def new_nospam
 
def filtration
 
def update_filtration
 
def get_friend_by_number
 
def get_friend
 
def get_active
 
def set_active
 
def get_last_message
 
def get_active_number
 
def get_active_name
 
def is_active_online
 
def new_name
 
def update
 
def send_files
 
def friend_exit
 
def send_typing
 
def friend_typing
 
def receipt
 
def send_messages
 
def split_and_send
 
def new_message
 
def send_message
 
def delete_message
 
def save_history
 
def clear_history
 
def load_history
 
def export_db
 
def export_history
 
def create_friend_item
 
def create_message_item
 
def create_file_transfer_item
 
def create_unsent_file_item
 
def create_inline_item
 
def set_alias
 
def friend_public_key
 
def delete_friend
 
def add_friend
 
def block_user
 
def unblock_user
 
def send_friend_request
 
def process_friend_request
 
def reset
 
def reconnect
 
def close
 
def incoming_file_transfer
 
def cancel_transfer
 
def cancel_not_started_transfer
 
def pause_transfer
 
def resume_transfer
 
def accept_transfer
 
def send_screenshot
 
def send_sticker
 
def send_inline
 
def send_file
 
def incoming_chunk
 
def outgoing_chunk
 
def transfer_finished
 
def send_avatar
 
def incoming_avatar
 
def reset_avatar
 
def set_avatar
 
def get_call
 
def call_click
 
def incoming_call
 
def accept_call
 
def stop_call
 
- Public Member Functions inherited from toxygen.contact.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
 
def get_pixmap
 

Public Attributes

 name
 
 status
 

Properties

 active_friend = property(get_active, set_active)
 
 call = property(get_call)
 
- Properties inherited from toxygen.contact.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 toxygen.profile.Profile.__init__ (   self,
  tox,
  screen 
)
:param tox: tox instance
:param screen: ref to main screen

Member Function Documentation

def toxygen.profile.Profile.accept_call (   self,
  friend_number,
  audio,
  video 
)
Accept incoming call with audio or video
def toxygen.profile.Profile.accept_transfer (   self,
  item,
  path,
  friend_number,
  file_number,
  size,
  inline = False,
  from_position = 0 
)
:param item: transfer item.
:param path: path for saving
:param friend_number: friend number
:param file_number: file number
:param size: file size
:param inline: is inline image
:param from_position: position for start
def toxygen.profile.Profile.add_friend (   self,
  tox_id 
)
Adds friend to list
def toxygen.profile.Profile.block_user (   self,
  tox_id 
)
Block user with specified tox id (or public key) - delete from friends list and ignore friend requests
def toxygen.profile.Profile.call_click (   self,
  audio = True,
  video = False 
)
User clicked audio button in main window
def toxygen.profile.Profile.cancel_transfer (   self,
  friend_number,
  file_number,
  already_cancelled = False 
)
Stop transfer
:param friend_number: number of friend
:param file_number: file number
:param already_cancelled: was cancelled by friend
def toxygen.profile.Profile.change_status (   self)
Changes status of user (online, away, busy)
def toxygen.profile.Profile.clear_history (   self,
  num = None,
  save_unsent = False 
)
Clear chat history
def toxygen.profile.Profile.create_friend_item (   self)
Method-factory
:return: new widget for friend instance
def toxygen.profile.Profile.delete_friend (   self,
  num 
)
Removes friend from contact list
:param num: number of friend in list
def toxygen.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 toxygen.profile.Profile.friend_exit (   self,
  friend_number 
)
Friend with specified number quit
def toxygen.profile.Profile.friend_typing (   self,
  friend_number,
  typing 
)
Display incoming typing notification
def toxygen.profile.Profile.incoming_avatar (   self,
  friend_number,
  file_number,
  size 
)
Friend changed avatar
:param friend_number: friend number
:param file_number: file number
:param size: size of avatar or 0 (default avatar)
def toxygen.profile.Profile.incoming_call (   self,
  audio,
  video,
  friend_number 
)
Incoming call from friend. Only audio is supported now
def toxygen.profile.Profile.incoming_chunk (   self,
  friend_number,
  file_number,
  position,
  data 
)
Incoming chunk
def toxygen.profile.Profile.incoming_file_transfer (   self,
  friend_number,
  file_number,
  size,
  file_name 
)
New transfer
:param friend_number: number of friend who sent file
:param file_number: file number
:param size: file size in bytes
:param file_name: file name without path
def toxygen.profile.Profile.load_history (   self)
Tries to load next part of messages
def toxygen.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 toxygen.profile.Profile.new_nospam (   self)
Sets new nospam part of tox id
def toxygen.profile.Profile.outgoing_chunk (   self,
  friend_number,
  file_number,
  position,
  size 
)
Outgoing chunk
def toxygen.profile.Profile.pause_transfer (   self,
  friend_number,
  file_number,
  by_friend = False 
)
Pause transfer with specified data
def toxygen.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 toxygen.profile.Profile.reset (   self,
  restart 
)
Recreate tox instance
:param restart: method which calls restart and returns new tox instance
def toxygen.profile.Profile.resume_transfer (   self,
  friend_number,
  file_number,
  by_friend = False 
)
Resume transfer with specified data
def toxygen.profile.Profile.save_history (   self)
Save history to db
def toxygen.profile.Profile.send_avatar (   self,
  friend_number 
)
:param friend_number: number of friend who should get new avatar
def toxygen.profile.Profile.send_file (   self,
  path,
  number = None,
  is_resend = False,
  file_id = None 
)
Send file to current active friend
:param path: file path
:param number: friend_number
:param is_resend: is 'offline' message
:param file_id: file id of transfer
def toxygen.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 toxygen.profile.Profile.send_message (   self,
  text,
  friend_num = None 
)
Send message
:param text: message text
:param friend_num: num of friend
def toxygen.profile.Profile.send_messages (   self,
  friend_number 
)
Send 'offline' messages to friend
def toxygen.profile.Profile.send_screenshot (   self,
  data 
)
Send screenshot to current active friend
:param data: raw data - png
def toxygen.profile.Profile.send_typing (   self,
  typing 
)
Send typing notification to a friend
def toxygen.profile.Profile.set_active (   self,
  value = None 
)
Change current active friend or update info
:param value: number of new active friend in friend's list or None to update active user's data
def toxygen.profile.Profile.set_alias (   self,
  num 
)
Set new alias for friend
def toxygen.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 toxygen.profile.Profile.stop_call (   self,
  friend_number,
  by_friend 
)
Stop call with friend
def toxygen.profile.Profile.unblock_user (   self,
  tox_id,
  add_to_friend_list 
)
Unblock user
:param tox_id: tox id of contact
:param add_to_friend_list: add this contact to friend list or not
def toxygen.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: