Tox

---

Object Hierarchy:

Description:

Content:

Properties:

• public uint32 self_nospam { get; set; }
  The 4-byte nospam part of the address. This value is expected in host byte order. I.e. 0x12345678 will form the bytes [12, 34, 56, 78] in the nospam part of the Tox friend address.
• public UserStatus self_status { get; set; }
  The client's user status.

Delegates:

• public delegate void ConferenceConnectedCallback (Tox self, uint32 conference_number, void* user_data)
• public delegate void ConferenceInviteCallback (Tox self, uint32 friend_number, ConferenceType type, uint8[] cookie, void* user_data)
  The invitation will remain valid until the inviting friend goes offline or exits the conference.
• public delegate void ConferenceMessageCallback (Tox self, uint32 conference_number, uint32 peer_number, MessageType type, uint8[] message, void* user_data)
• public delegate void ConferencePeerListChangedCallback (Tox self, uint32 conference_number, void* user_data)
• public delegate void ConferencePeerNameCallback (Tox self, uint32 conference_number, uint32 peer_number, uint8[] name, void* user_data)
• public delegate void ConferenceTitleCallback (Tox self, uint32 conference_number, uint32 peer_number, uint8[] title, void* user_data)
• public delegate void FileChunkRequestCallback (Tox self, uint32 friend_number, uint32 file_number, uint64 position, size_t length, void* user_data)
  If the length parameter is 0, the file transfer is finished, and the client's resources associated with the file number should be released. After a call with zero length, the file number can be reused for future file transfers.
• public delegate void FileRecvCallback (Tox self, uint32 friend_number, uint32 file_number, uint32 kind, uint64 file_size, uint8[] filename, void* user_data)
  The client should acquire resources to be associated with the file transfer. Incoming file transfers start in the PAUSED state. After this callback returns, a transfer can be rejected by sending a FileControl.CANCEL control command before any other control commands. It can be accepted by sending FileControl.RESUME.
• public delegate void FileRecvChunkCallback (Tox self, uint32 friend_number, uint32 file_number, uint64 position, uint8[] data, void* user_data)
  When length is 0, the transfer is finished and the client should release the resources it acquired for the transfer. After a call with length = 0, the file number can be reused for new file transfers.
• public delegate void FileRecvControlCallback (Tox self, uint32 friend_number, uint32 file_number, FileControl control, void* user_data)
  When receiving FileControl.CANCEL, the client should release the resources associated with the file number and consider the transfer failed.
• public delegate void FriendConnectionStatusCallback (Tox self, uint32 friend_number, Connection connection_status, void* userdata)
• public delegate void FriendLosslessPacketCallback (Tox self, uint32 friend_number, uint8[] data, void* user_data)
• public delegate void FriendLossyPacketCallback (Tox self, uint32 friend_number, uint8[] data, void* user_data)
• public delegate void FriendMessageCallback (Tox self, uint32 friend_number, MessageType type, uint8[] message, void* user_data)
• public delegate void FriendNameCallback (Tox self, uint32 friend_number, uint8[] name, void* user_data)
• public delegate void FriendReadReceiptCallback (Tox self, uint32 friend_number, uint32 message_id, void* user_data)
• public delegate void FriendRequestCallback (Tox self, uint8[] public_key, uint8[] message, void* user_data)
• public delegate void FriendStatusCallback (Tox self, uint32 friend_number, UserStatus status, void* user_data)
• public delegate void FriendStatusMessageCallback (Tox self, uint32 friend_number, uint8[] message, void* user_data)
• public delegate void FriendTypingCallback (Tox self, uint32 friend_number, bool is_typing, void* userdata)
• public delegate void SelfConnectionStatusCallback (Tox self, Connection connection_status, void* user_data)

Static methods:

• public static uint8[]? hash (uint8[] data)
  Generates a cryptographic hash of the given data.

Creation methods:

• public Tox (Options? options = null, out ErrNew error = null)
  Creates and initialises a new Tox instance with the options passed.

Methods:

• public bool add_tcp_relay (string host, uint16 port, uint8[] public_key, out ErrBootstrap error = null)
  Adds additional host:port pair as TCP relay.
• public bool bootstrap (string host, uint16 port, uint8[] public_key, out ErrBootstrap error = null)
  Sends a "get nodes" request to the given bootstrap node with IP, port, and public key to setup connections.
• public void callback_conference_connected (ConferenceConnectedCallback callback)
  Set the callback for the `conference_connected` event. Pass NULL to unset.
• public void callback_conference_invite (ConferenceInviteCallback callback)
  Set the callback for the `conference_invite` event. Pass NULL to unset.
• public void callback_conference_message (ConferenceMessageCallback callback)
  Set the callback for the `conference_message` event. Pass NULL to unset.
• public void callback_conference_peer_list_changed (ConferencePeerListChangedCallback callback)
  Set the callback for the `conference_peer_list_changed` event. Pass NULL to unset.
• public void callback_conference_peer_name (ConferencePeerNameCallback callback)
  Set the callback for the `conference_peer_name` event. Pass NULL to unset.
• public void callback_conference_title (ConferenceTitleCallback callback)
  Set the callback for the `conference_title` event. Pass NULL to unset.
• public void callback_file_chunk_request (FileChunkRequestCallback callback)
  Set the callback for the `file_chunk_request` event. Pass NULL to unset.
• public void callback_file_recv (FileRecvCallback callback)
  Set the callback for the `file_recv` event. Pass NULL to unset.
• public void callback_file_recv_chunk (FileRecvChunkCallback callback)
  Set the callback for the `file_recv_chunk` event. Pass NULL to unset.
• public void callback_file_recv_control (FileRecvControlCallback callback)
  Set the callback for the `file_recv_control` event. Pass NULL to unset.
• public void callback_friend_connection_status (FriendConnectionStatusCallback callback)
  Set the callback for the `friend_connection_status` event. Pass NULL to unset.
• public void callback_friend_lossless_packet (FriendLosslessPacketCallback callback)
  Set the callback for the `friend_lossless_packet` event. Pass NULL to unset.
• public void callback_friend_lossy_packet (FriendLossyPacketCallback callback)
  Set the callback for the `friend_lossy_packet` event. Pass NULL to unset.
• public void callback_friend_message (FriendMessageCallback callback)
  Set the callback for the `friend_message` event. Pass NULL to unset.
• public void callback_friend_name (FriendNameCallback callback)
  Set the callback for the `friend_name` event. Pass NULL to unset.
• public void callback_friend_read_receipt (FriendReadReceiptCallback callback)
  Set the callback for the `friend_read_receipt` event. Pass NULL to unset.
• public void callback_friend_request (FriendRequestCallback callback)
  Set the callback for the `friend_request` event. Pass NULL to unset.
• public void callback_friend_status (FriendStatusCallback callback)
  Set the callback for the `friend_status` event. Pass NULL to unset.
• public void callback_friend_status_message (FriendStatusMessageCallback callback)
  Set the callback for the `friend_status_message` event. Pass NULL to unset.
• public void callback_friend_typing (FriendTypingCallback callback)
  Set the callback for the `friend_typing` event. Pass NULL to unset.
• public void callback_self_connection_status (SelfConnectionStatusCallback callback)
  Set the callback for the `self_connection_status` event. Pass NULL to unset.
• public uint32 conference_by_id (uint8[] id, out ErrConferenceById error = null)
  Return the conference number associated with the specified id.
• public uint32 conference_by_uid (uint8[] id, out ErrConferenceByUId error = null)
  Return the conference number associated with the specified id.
• public bool conference_delete (uint32 conference_number, out ErrConferenceDelete error = null)
  This function deletes a conference.
• public uint32[] conference_get_chatlist ()
  Return a list of valid conference IDs.
• public uint8[]? conference_get_id (uint32 conference_number)
  Get the conference unique ID.
• public string? conference_get_title (uint32 conference_number, out ErrConferenceTitle error = null)
  Return the title designated by the given conference number.
• public ConferenceType conference_get_type (uint32 conference_number, out ErrConferenceGetType error = null)
• public uint8[]? conference_get_uid (uint32 conference_number)
  Get the conference unique ID.
• public bool conference_invite (uint32 friend_number, uint32 conference_number, out ErrConferenceInvite error = null)
  Invites a friend to a conference.
• public uint32 conference_join (uint32 friend_number, uint8[] cookie, out ErrConferenceJoin error = null)
  Joins a conference that the client has been invited to.
• public uint32 conference_new (out ErrConferenceNew error = null)
  Creates a new conference.
• public uint32 conference_offline_peer_count (uint32 conference_number, out ErrConferencePeerQuery error = null)
  Return the number of offline peers in the conference. Return value is unspecified on failure.
• public uint64 conference_offline_peer_get_last_active (uint32 conference_number, uint32 offline_peer_number, out ErrConferencePeerQuery error = null)
  Return a unix-time timestamp of the last time offline_peer_number was seen to be active.
• public string? conference_offline_peer_get_name (uint32 conference_number, uint32 offline_peer_number, out ErrConferencePeerQuery error = null)
  Get the name of offline_peer_number who is in conference_number.
• public size_t conference_offline_peer_get_name_size (uint32 conference_number, uint32 offline_peer_number, out ErrConferencePeerQuery error = null)
  Return the length of the offline peer's name. Return value is unspecified on failure.
• public uint8[]? conference_offline_peer_get_public_key (uint32 conference_number, uint32 offline_peer_number, out ErrConferencePeerQuery error = null)
  Get the public key of offline_peer_number who is in conference_number. public_key must be TOX_PUBLIC_KEY_SIZE long.
• public uint32 conference_peer_count (uint32 conference_number, out ErrConferencePeerQuery error = null)
  Return the number of peers in the conference. Return value is unspecified on failure.
• public string? conference_peer_get_name (uint32 conference_number, uint32 peer_number, out ErrConferencePeerQuery error = null)
  Return the name of peer_number who is in conference_number.
• public uint8[]? conference_peer_get_public_key (uint32 conference_number, uint32 peer_number, out ErrConferencePeerQuery error = null)
  Return the public key of peer_number who is in conference_number.
• public bool conference_peer_number_is_ours (uint32 conference_number, uint32 peer_number, out ErrConferencePeerQuery error = null)
  Return true if passed peer_number corresponds to our own.
• public bool conference_send_message (uint32 conference_number, MessageType type, string message, out ErrConferenceSendMessage error = null)
  Send a text chat message to the conference.
• public bool conference_set_max_offline (uint32 conference_number, uint32 max_offline_peers, out ErrConferenceSetMaxOffline error = null)
  Set maximum number of offline peers to store, overriding the default.
• public bool conference_set_title (uint32 conference_number, string title, out ErrConferenceTitle error = null)
  Set the conference title and broadcast it to the rest of the conference.
• public bool file_control (uint32 friend_number, uint32 file_number, FileControl control, out ErrFileControl error = null)
  Sends a file control command to a friend for a given file transfer.
• public uint8[]? file_get_file_id (uint32 friend_number, uint32 file_number, out ErrFileGet error = null)
  Copy the file id associated to the file transfer to a byte array.
• public bool file_seek (uint32 friend_number, uint32 file_number, uint64 position, out ErrFileSeek error = null)
  Sends a file seek control command to a friend for a given file transfer.
• public uint32 file_send (uint32 friend_number, FileKind kind, uint64 file_size, uint8[]? file_id, string filename, out ErrFileSend error = null)
  Send a file transmission request.
• public bool file_send_chunk (uint32 friend_number, uint32 file_number, uint64 position, uint8[] data, out ErrFileSendChunk error = null)
  Send a chunk of file data to a friend.
• public uint32 friend_add (uint8[] address, string message, out ErrFriendAdd error = null)
  Add a friend to the friend list and send a friend request.
• public uint32 friend_add_norequest (uint8[] public_key, out ErrFriendAdd error = null)
  Add a friend without sending a friend request.
• public uint32 friend_by_public_key (uint8[] public_key, out ErrFriendByPublicKey error = null)
  Return the friend number associated with that Public Key.
• public bool friend_delete (uint32 friend_number, out ErrFriendDelete error = null)
  Remove a friend from the friend list.
• public bool friend_exists (uint32 friend_number)
  Checks if a friend with the given friend number exists and returns true if it does.
• public Connection friend_get_connection_status (uint32 friend_number, out ErrFriendQuery error = null)
  Check whether a friend is currently connected to this client.
• public uint64 friend_get_last_online (uint32 friend_number, out ErrFriendGetLastOnline error = null)
  Return a unix-time timestamp of the last time the friend associated with a given friend number was seen online. This function will return UINT64_MAX on error.
• public string? friend_get_name (uint32 friend_number, out ErrFriendQuery error = null)
  Return the name of the friend designated by the given friend number.
• public uint8[] friend_get_public_key (uint32 friend_number, out ErrFriendGetPublicKey error = null)
  Returns the Public Key associated with a given friend number.
• public UserStatus friend_get_status (uint32 friend_number, out ErrFriendQuery error = null)
  Return the friend's user status (away/busy/...). If the friend number is invalid, the return value is unspecified.
• public string? friend_get_status_message (uint32 friend_number, out ErrFriendQuery error = null)
  Return the status message of the friend designated by the given friend number.
• public bool friend_get_typing (uint32 friend_number, out ErrFriendQuery error = null)
  Check whether a friend is currently typing a message.
• public bool friend_send_lossless_packet (uint32 friend_number, uint8[] data, out ErrFriendCustomPacket error = null)
  Send a custom lossless packet to a friend.
• public bool friend_send_lossy_packet (uint32 friend_number, uint8[] data, out ErrFriendCustomPacket error = null)
  Send a custom lossy packet to a friend.
• public uint32 friend_send_message (uint32 friend_number, MessageType type, string message, out ErrFriendSendMessage error = null)
  Send a text chat message to an online friend.
• public uint8[] get_savedata ()
  Store all information associated with the tox instance to a byte array.
• public void iterate (void* user_data)
  The main loop that needs to be run in intervals of iteration_interval milliseconds.
• public uint32 iteration_interval ()
  Return the time in milliseconds before iterate should be called again for optimal performance.
• public uint8[] self_get_address ()
  Writes the Tox friend address of the client to a byte array. The address is not in human-readable format. If a client wants to display the address, formatting is required.
• public Connection self_get_connection_status ()
  Return whether we are connected to the DHT. The return value is equal to the last value received through the `self_connection_status` callback.
• public uint8[] self_get_dht_id ()
  Returns the temporary DHT public key of this instance.
• public uint32[] self_get_friend_list ()
  Copy a list of valid friend numbers into an array.
• public string self_get_name ()
  Write the nickname set by Tox.self_set_name to a byte array.
• public uint8[] self_get_public_key ()
  Copy the Tox Public Key (long term) from the Tox object.
• public uint8[] self_get_secret_key ()
  Copy the Tox Secret Key from the Tox object.
• public string self_get_status_message ()
  Write the status message set by Tox.self_set_status_message to a byte array.
• public uint16 self_get_tcp_port (out ErrGetPort error = null)
  Return the TCP port this Tox instance is bound to. This is only relevant if the instance is acting as a TCP relay.
• public uint16 self_get_udp_port (out ErrGetPort error = null)
  Return the UDP port this Tox instance is bound to.
• public bool self_set_name (string name, out ErrSetInfo error = null)
  Set the nickname for the Tox client.
• public bool self_set_status_message (string message, out ErrSetInfo error = null)
  Set the client's status message.
• public bool self_set_typing (uint32 friend_number, bool typing, out ErrSetTyping error = null)
  Set the client's typing status for a friend.