C# Class SharpTox.Core.Tox

Represents an instance of tox.

Inheritance: IDisposable

Mostrar archivo Open project: hexafluoride/Detox Class Usage Examples

Public Methods

Method	Description
AddFriend ( ToxId id, string message ) : int	Adds a friend to the friend list and sends a friend request.
AddFriend ( ToxId id, string message, ToxErrorFriendAdd &error ) : int	Adds a friend to the friend list and sends a friend request.
AddFriendNoRequest ( ToxKey publicKey ) : int	Adds a friend to the friend list without sending a friend request. This method should be used to accept friend requests.
AddFriendNoRequest ( ToxKey publicKey, ToxErrorFriendAdd &error ) : int	Adds a friend to the friend list without sending a friend request. This method should be used to accept friend requests.
AddTcpRelay ( ToxNode node ) : bool	Adds a node as a TCP relay. This method can be used to initiate TCP connections to different ports on the same bootstrap node, or to add TCP relays without using them as bootstrap nodes.
AddTcpRelay ( ToxNode node, ToxErrorBootstrap &error ) : bool	Adds a node as a TCP relay. This method can be used to initiate TCP connections to different ports on the same bootstrap node, or to add TCP relays without using them as bootstrap nodes.
Bootstrap ( ToxNode node ) : bool	Attempts to bootstrap this Tox instance with a ToxNode. A 'getnodes' request is sent to the given node.
Bootstrap ( ToxNode node, ToxErrorBootstrap &error ) : bool	Attempts to bootstrap this Tox instance with a ToxNode. A 'getnodes' request is sent to the given node.
DeleteFriend ( int friendNumber ) : bool	Deletes a friend from the friend list.
DeleteFriend ( int friendNumber, ToxErrorFriendDelete &error ) : bool	Deletes a friend from the friend list.
DeleteGroupChat ( int groupNumber ) : bool	Deletes a group chat.
Dispose ( ) : void	Releases all resources used by this instance of Tox.
FileControl ( int friendNumber, int fileNumber, ToxFileControl control ) : bool	Sends a file control command to a friend for a given file transfer.
FileControl ( int friendNumber, int fileNumber, ToxFileControl control, ToxErrorFileControl &error ) : bool	Sends a file control command to a friend for a given file transfer.
FileGetId ( int friendNumber, int fileNumber ) : byte[]	Retrieves the unique id of a file transfer. This can be used to uniquely identify file transfers across core restarts.
FileGetId ( int friendNumber, int fileNumber, ToxErrorFileGet &error ) : byte[]	Retrieves the unique id of a file transfer. This can be used to uniquely identify file transfers across core restarts.
FileSeek ( int friendNumber, int fileNumber, long position ) : bool	Sends a file seek control command to a friend for a given file transfer.
FileSeek ( int friendNumber, int fileNumber, long position, ToxErrorFileSeek &error ) : bool	Sends a file seek control command to a friend for a given file transfer.
FileSend ( int friendNumber, ToxFileKind kind, long fileSize, string fileName ) : ToxFileInfo	Send a file transmission request.
FileSend ( int friendNumber, ToxFileKind kind, long fileSize, string fileName, ToxErrorFileSend &error ) : ToxFileInfo	Send a file transmission request.
FileSend ( int friendNumber, ToxFileKind kind, long fileSize, string fileName, byte fileId ) : ToxFileInfo	Send a file transmission request.
FileSend ( int friendNumber, ToxFileKind kind, long fileSize, string fileName, byte fileId, ToxErrorFileSend &error ) : ToxFileInfo	Send a file transmission request.
FileSendChunk ( int friendNumber, int fileNumber, long position, byte data ) : bool	Sends a chunk of file data to a friend. This should be called in response to OnFileChunkRequested.
FileSendChunk ( int friendNumber, int fileNumber, long position, byte data, ToxErrorFileSendChunk &error ) : bool	Sends a chunk of file data to a friend. This should be called in response to OnFileChunkRequested.
FriendExists ( int friendNumber ) : bool	Checks if there exists a friend with given friendNumber.
FriendSendLosslessPacket ( int friendNumber, byte data ) : bool	Sends a custom lossless packet to a friend. Lossless packets behave like TCP, they're reliable and arrive in order. The difference is that it's not a stream.
FriendSendLosslessPacket ( int friendNumber, byte data, ToxErrorFriendCustomPacket &error ) : bool	Sends a custom lossless packet to a friend. Lossless packets behave like TCP, they're reliable and arrive in order. The difference is that it's not a stream.
FriendSendLossyPacket ( int friendNumber, byte data ) : bool	Sends a custom lossy packet to a friend. Lossy packets are like UDP packets, they may never reach the other side, arrive more than once or arrive in the wrong order.
FriendSendLossyPacket ( int friendNumber, byte data, ToxErrorFriendCustomPacket &error ) : bool	Sends a custom lossy packet to a friend. Lossy packets are like UDP packets, they may never reach the other side, arrive more than once or arrive in the wrong order.
GetData ( ) : ToxData	Retrieves a ToxData object that contains the profile data of this Tox instance.
GetData ( ToxEncryptionKey key ) : ToxData	Retrieves a ToxData object that contains the profile data of this Tox instance, encrypted with the provided key.
GetFriendByPublicKey ( ToxKey publicKey ) : int	Retrieves the friendNumber associated with the specified public key.
GetFriendByPublicKey ( ToxKey publicKey, ToxErrorFriendByPublicKey &error ) : int	Retrieves the friendNumber associated with the specified public key.
GetFriendConnectionStatus ( int friendNumber ) : ToxConnectionStatus	Retrieves a friend's connection status.
GetFriendConnectionStatus ( int friendNumber, ToxErrorFriendQuery &error ) : ToxConnectionStatus	Retrieves a friend's connection status.
GetFriendLastOnline ( int friendNumber ) : System.DateTime	Retrieves the time a friend was last seen online.
GetFriendLastOnline ( int friendNumber, ToxErrorFriendGetLastOnline &error ) : System.DateTime	Retrieves the time a friend was last seen online.
GetFriendName ( int friendNumber ) : string	Retrieves the name of a friend.
GetFriendName ( int friendNumber, ToxErrorFriendQuery &error ) : string	Retrieves the name of a friend.
GetFriendPublicKey ( int friendNumber ) : ToxKey	Retrieves a friend's public key.
GetFriendPublicKey ( int friendNumber, ToxErrorFriendGetPublicKey &error ) : ToxKey	Retrieves a friend's public key.
GetFriendStatus ( int friendNumber ) : ToxUserStatus	Retrieves a friend's current status.
GetFriendStatus ( int friendNumber, ToxErrorFriendQuery &error ) : ToxUserStatus	Retrieves a friend's current status.
GetFriendStatusMessage ( int friendNumber ) : string	Retrieves the status message of a friend.
GetFriendStatusMessage ( int friendNumber, ToxErrorFriendQuery &error ) : string	Retrieves the status message of a friend.
GetFriendTypingStatus ( int friendNumber ) : bool	Retrieves the typing status of a friend.
GetFriendTypingStatus ( int friendNumber, ToxErrorFriendQuery &error ) : bool	Retrieves the typing status of a friend.
GetGroupMemberCount ( int groupNumber ) : int	Retrieves the number of group members in a group chat.
GetGroupMemberName ( int groupNumber, int peerNumber ) : string	Retrieves the name of a group member.
GetGroupNames ( int groupNumber ) : string[]	Retrieves an array of group member names.
GetGroupPeerPublicKey ( int groupNumber, int peerNumber ) : ToxKey	Retrieves the public key of a peer.
GetGroupTitle ( int groupNumber ) : string	Retrieves the title of a group.
GetGroupType ( int groupNumber ) : ToxGroupType	Retrieves the type of a group.
GetPrivateKey ( ) : ToxKey	Retrieves the private key of this Tox instance.
GetTcpPort ( ) : int	Retrieves the TCP port this instance of Tox is bound to.
GetTcpPort ( ToxErrorGetPort &error ) : int	Retrieves the TCP port this instance of Tox is bound to.
GetUdpPort ( ) : int	Retrieves the UDP port this instance of Tox is bound to.
GetUdpPort ( ToxErrorGetPort &error ) : int	Retrieves the UDP port this instance of Tox is bound to.
InviteFriend ( int friendNumber, int groupNumber ) : bool	Invites a friend to a group chat.
IsFriendOnline ( int friendNumber ) : bool	Check whether or not a friend is online.
Iterate ( ) : int	Runs the tox_iterate once in the current thread.
JoinGroup ( int friendNumber, byte data ) : int	Joins a group with the given public key of the group.
NewGroup ( ) : int	Creates a new group and retrieves the group number.
PeerNumberIsOurs ( int groupNumber, int peerNumber ) : bool	Check if the given peernumber corresponds to ours.
SendGroupAction ( int groupNumber, string action ) : bool	Sends an action to a group.
SendGroupMessage ( int groupNumber, string message ) : bool	Sends a message to a group.
SendMessage ( int friendNumber, string message, ToxMessageType type ) : int	Sends a message to a friend.
SendMessage ( int friendNumber, string message, ToxMessageType type, ToxErrorSendMessage &error ) : int	Sends a message to a friend.
SetGroupTitle ( int groupNumber, string title ) : bool	Changes the title of a group.
SetTypingStatus ( int friendNumber, bool isTyping ) : bool	Sets the typing status of this Tox instance for a friend.
SetTypingStatus ( int friendNumber, bool isTyping, ToxErrorSetTyping &error ) : bool	Sets the typing status of this Tox instance for a friend.
Start ( ) : void	Starts the main 'tox_iterate' loop at an interval retrieved with 'tox_iteration_interval'. If you want to manage your own loop, use the Iterate method instead.
Stop ( ) : void	Stops the main tox_do loop if it's running.
Tox ( ToxOptions options, ToxData data, ToxEncryptionKey key = null ) : System	Initializes a new instance of Tox.
Tox ( ToxOptions options, ToxKey secretKey = null ) : System	Initializes a new instance of Tox. If no secret key is specified, toxcore will generate a new keypair.

Private Methods

Method	Description
Dispose ( bool disposing ) : void
DoIterate ( ) : int
GetNospam ( ) : uint
Loop ( ) : void
SetNospam ( uint nospam ) : void
ThrowIfDisposed ( ) : void

Method Details

AddFriend() public method

Adds a friend to the friend list and sends a friend request.

public AddFriend ( ToxId id, string message ) : int
id	ToxId	The Tox id of the friend to add.
message	string	The message that will be sent along with the friend request.
return	int

AddFriend() public method

Adds a friend to the friend list and sends a friend request.

public AddFriend ( ToxId id, string message, ToxErrorFriendAdd &error ) : int
id	ToxId	The Tox id of the friend to add.
message	string	The message that will be sent along with the friend request.
error	ToxErrorFriendAdd
return	int

AddFriendNoRequest() public method

Adds a friend to the friend list without sending a friend request. This method should be used to accept friend requests.

public AddFriendNoRequest ( ToxKey publicKey ) : int
publicKey	ToxKey	The public key of the friend to add.
return	int

AddFriendNoRequest() public method

Adds a friend to the friend list without sending a friend request. This method should be used to accept friend requests.

public AddFriendNoRequest ( ToxKey publicKey, ToxErrorFriendAdd &error ) : int
publicKey	ToxKey	The public key of the friend to add.
error	ToxErrorFriendAdd
return	int

AddTcpRelay() public method

Adds a node as a TCP relay. This method can be used to initiate TCP connections to different ports on the same bootstrap node, or to add TCP relays without using them as bootstrap nodes.

public AddTcpRelay ( ToxNode node ) : bool
node	ToxNode	The node to add.
return	bool

AddTcpRelay() public method

Adds a node as a TCP relay. This method can be used to initiate TCP connections to different ports on the same bootstrap node, or to add TCP relays without using them as bootstrap nodes.

public AddTcpRelay ( ToxNode node, ToxErrorBootstrap &error ) : bool
node	ToxNode	The node to add.
error	ToxErrorBootstrap
return	bool

Bootstrap() public method

Attempts to bootstrap this Tox instance with a ToxNode. A 'getnodes' request is sent to the given node.

public Bootstrap ( ToxNode node ) : bool
node	ToxNode	The node to bootstrap off of.
return	bool

Bootstrap() public method

Attempts to bootstrap this Tox instance with a ToxNode. A 'getnodes' request is sent to the given node.

public Bootstrap ( ToxNode node, ToxErrorBootstrap &error ) : bool
node	ToxNode	The node to bootstrap off of.
error	ToxErrorBootstrap
return	bool

DeleteFriend() public method

Deletes a friend from the friend list.

public DeleteFriend ( int friendNumber ) : bool
friendNumber	int	The friend number to be deleted.
return	bool

DeleteFriend() public method

Deletes a friend from the friend list.

public DeleteFriend ( int friendNumber, ToxErrorFriendDelete &error ) : bool
friendNumber	int	The friend number to be deleted.
error	ToxErrorFriendDelete
return	bool

DeleteGroupChat() public method

Deletes a group chat.

public DeleteGroupChat ( int groupNumber ) : bool
groupNumber	int	The group to delete.
return	bool

Dispose() public method

Releases all resources used by this instance of Tox.

public Dispose ( ) : void
return	void

FileControl() public method

Sends a file control command to a friend for a given file transfer.

public FileControl ( int friendNumber, int fileNumber, ToxFileControl control ) : bool
friendNumber	int	The friend to send the file control to.
fileNumber	int	The file transfer that this control is meant for.
control	ToxFileControl	The control to send.
return	bool

FileControl() public method

Sends a file control command to a friend for a given file transfer.

public FileControl ( int friendNumber, int fileNumber, ToxFileControl control, ToxErrorFileControl &error ) : bool
friendNumber	int	The friend to send the file control to.
fileNumber	int	The file transfer that this control is meant for.
control	ToxFileControl	The control to send.
error	ToxErrorFileControl
return	bool

FileGetId() public method

Retrieves the unique id of a file transfer. This can be used to uniquely identify file transfers across core restarts.

public FileGetId ( int friendNumber, int fileNumber ) : byte[]
friendNumber	int	The friend number that's associated with this transfer.
fileNumber	int	The target file transfer.
return	byte[]

FileGetId() public method

Retrieves the unique id of a file transfer. This can be used to uniquely identify file transfers across core restarts.

public FileGetId ( int friendNumber, int fileNumber, ToxErrorFileGet &error ) : byte[]
friendNumber	int	The friend number that's associated with this transfer.
fileNumber	int	The target file transfer.
error	ToxErrorFileGet
return	byte[]

FileSeek() public method

Sends a file seek control command to a friend for a given file transfer.

public FileSeek ( int friendNumber, int fileNumber, long position ) : bool
friendNumber	int	The friend to send the seek command to.
fileNumber	int	The file transfer that this command is meant for.
position	long	The position that the friend should change his stream to.
return	bool

FileSeek() public method

Sends a file seek control command to a friend for a given file transfer.

public FileSeek ( int friendNumber, int fileNumber, long position, ToxErrorFileSeek &error ) : bool
friendNumber	int	The friend to send the seek command to.
fileNumber	int	The file transfer that this command is meant for.
position	long	The position that the friend should change his stream to.
error	ToxErrorFileSeek
return	bool

FileSend() public method

Send a file transmission request.

public FileSend ( int friendNumber, ToxFileKind kind, long fileSize, string fileName ) : ToxFileInfo
friendNumber	int	The friend number to send the request to.
kind	ToxFileKind	The kind of file that will be transferred.
fileSize	long	The size of the file that will be transferred.
fileName	string	The filename of the file that will be transferred.
return	ToxFileInfo

FileSend() public method

Send a file transmission request.

public FileSend ( int friendNumber, ToxFileKind kind, long fileSize, string fileName, ToxErrorFileSend &error ) : ToxFileInfo
friendNumber	int	The friend number to send the request to.
kind	ToxFileKind	The kind of file that will be transferred.
fileSize	long	The size of the file that will be transferred.
fileName	string	The filename of the file that will be transferred.
error	ToxErrorFileSend
return	ToxFileInfo

FileSend() public method

Send a file transmission request.

public FileSend ( int friendNumber, ToxFileKind kind, long fileSize, string fileName, byte fileId ) : ToxFileInfo
friendNumber	int	The friend number to send the request to.
kind	ToxFileKind	The kind of file that will be transferred.
fileSize	long	The size of the file that will be transferred.
fileName	string	The filename of the file that will be transferred.
fileId	byte	The id to identify this transfer with. Should be ToxConstants.FileIdLength bytes long.
return	ToxFileInfo

FileSend() public method

Send a file transmission request.

public FileSend ( int friendNumber, ToxFileKind kind, long fileSize, string fileName, byte fileId, ToxErrorFileSend &error ) : ToxFileInfo
friendNumber	int	The friend number to send the request to.
kind	ToxFileKind	The kind of file that will be transferred.
fileSize	long	The size of the file that will be transferred.
fileName	string	The filename of the file that will be transferred.
fileId	byte	The id to identify this transfer with. Should be ToxConstants.FileIdLength bytes long.
error	ToxErrorFileSend
return	ToxFileInfo

FileSendChunk() public method

Sends a chunk of file data to a friend. This should be called in response to OnFileChunkRequested.

public FileSendChunk ( int friendNumber, int fileNumber, long position, byte data ) : bool
friendNumber	int	The friend to send the chunk to.
fileNumber	int	The file transfer that this chunk belongs to.
position	long	The position from which to continue reading.
data	byte	The data to send. (should be equal to 'Length' received through OnFileChunkRequested).
return	bool

FileSendChunk() public method

Sends a chunk of file data to a friend. This should be called in response to OnFileChunkRequested.

public FileSendChunk ( int friendNumber, int fileNumber, long position, byte data, ToxErrorFileSendChunk &error ) : bool
friendNumber	int	The friend to send the chunk to.
fileNumber	int	The file transfer that this chunk belongs to.
position	long	The position from which to continue reading.
data	byte	The data to send. (should be equal to 'Length' received through OnFileChunkRequested).
error	ToxErrorFileSendChunk
return	bool

FriendExists() public method

Checks if there exists a friend with given friendNumber.

public FriendExists ( int friendNumber ) : bool
friendNumber	int	The friend number to check.
return	bool

FriendSendLosslessPacket() public method

Sends a custom lossless packet to a friend. Lossless packets behave like TCP, they're reliable and arrive in order. The difference is that it's not a stream.

public FriendSendLosslessPacket ( int friendNumber, byte data ) : bool
friendNumber	int	The friend to send the packet to.
data	byte	The data to send. The first byte must be in the range 160-191. The maximum length of the data is ToxConstants.MaxCustomPacketSize
return	bool

FriendSendLosslessPacket() public method

Sends a custom lossless packet to a friend. Lossless packets behave like TCP, they're reliable and arrive in order. The difference is that it's not a stream.

public FriendSendLosslessPacket ( int friendNumber, byte data, ToxErrorFriendCustomPacket &error ) : bool
friendNumber	int	The friend to send the packet to.
data	byte	The data to send. The first byte must be in the range 160-191. The maximum length of the data is ToxConstants.MaxCustomPacketSize
error	ToxErrorFriendCustomPacket
return	bool

FriendSendLossyPacket() public method

Sends a custom lossy packet to a friend. Lossy packets are like UDP packets, they may never reach the other side, arrive more than once or arrive in the wrong order.

public FriendSendLossyPacket ( int friendNumber, byte data ) : bool
friendNumber	int	The friend to send the packet to.
data	byte	The data to send. The first byte must be in the range 200-254. The maximum length of the data is ToxConstants.MaxCustomPacketSize
return	bool

FriendSendLossyPacket() public method

Sends a custom lossy packet to a friend. Lossy packets are like UDP packets, they may never reach the other side, arrive more than once or arrive in the wrong order.

public FriendSendLossyPacket ( int friendNumber, byte data, ToxErrorFriendCustomPacket &error ) : bool
friendNumber	int	The friend to send the packet to.
data	byte	The data to send. The first byte must be in the range 200-254. The maximum length of the data is ToxConstants.MaxCustomPacketSize
error	ToxErrorFriendCustomPacket
return	bool

GetData() public method

Retrieves a ToxData object that contains the profile data of this Tox instance.

public GetData ( ) : ToxData
return	ToxData

GetData() public method

Retrieves a ToxData object that contains the profile data of this Tox instance, encrypted with the provided key.

public GetData ( ToxEncryptionKey key ) : ToxData
key	ToxEncryptionKey	The key to encrypt the Tox data with.
return	ToxData

GetFriendByPublicKey() public method

Retrieves the friendNumber associated with the specified public key.

public GetFriendByPublicKey ( ToxKey publicKey ) : int
publicKey	ToxKey	The public key to look for.
return	int

GetFriendByPublicKey() public method

Retrieves the friendNumber associated with the specified public key.

public GetFriendByPublicKey ( ToxKey publicKey, ToxErrorFriendByPublicKey &error ) : int
publicKey	ToxKey	The public key to look for.
error	ToxErrorFriendByPublicKey
return	int

GetFriendConnectionStatus() public method

Retrieves a friend's connection status.

public GetFriendConnectionStatus ( int friendNumber ) : ToxConnectionStatus
friendNumber	int	The friend number to retrieve the connection status of.
return	ToxConnectionStatus

GetFriendConnectionStatus() public method

Retrieves a friend's connection status.

public GetFriendConnectionStatus ( int friendNumber, ToxErrorFriendQuery &error ) : ToxConnectionStatus
friendNumber	int	The friend number to retrieve the connection status of.
error	ToxErrorFriendQuery
return	ToxConnectionStatus

GetFriendLastOnline() public method

Retrieves the time a friend was last seen online.

public GetFriendLastOnline ( int friendNumber ) : System.DateTime
friendNumber	int	The friend to retrieve the 'last online' of.
return	System.DateTime

GetFriendLastOnline() public method

Retrieves the time a friend was last seen online.

public GetFriendLastOnline ( int friendNumber, ToxErrorFriendGetLastOnline &error ) : System.DateTime
friendNumber	int	The friend to retrieve the 'last online' of.
error	ToxErrorFriendGetLastOnline
return	System.DateTime

GetFriendName() public method

Retrieves the name of a friend.

public GetFriendName ( int friendNumber ) : string
friendNumber	int	The friend number to retrieve the name of.
return	string

GetFriendName() public method

Retrieves the name of a friend.

public GetFriendName ( int friendNumber, ToxErrorFriendQuery &error ) : string
friendNumber	int	The friend number to retrieve the name of.
error	ToxErrorFriendQuery
return	string

GetFriendPublicKey() public method

Retrieves a friend's public key.

public GetFriendPublicKey ( int friendNumber ) : ToxKey
friendNumber	int	The friend number to retrieve the public key of.
return	ToxKey

GetFriendPublicKey() public method

Retrieves a friend's public key.

public GetFriendPublicKey ( int friendNumber, ToxErrorFriendGetPublicKey &error ) : ToxKey
friendNumber	int	The friend number to retrieve the public key of.
error	ToxErrorFriendGetPublicKey
return	ToxKey

GetFriendStatus() public method

Retrieves a friend's current status.

public GetFriendStatus ( int friendNumber ) : ToxUserStatus
friendNumber	int	The friend number to retrieve the status of.
return	ToxUserStatus

GetFriendStatus() public method

Retrieves a friend's current status.

public GetFriendStatus ( int friendNumber, ToxErrorFriendQuery &error ) : ToxUserStatus
friendNumber	int	The friend number to retrieve the status of.
error	ToxErrorFriendQuery
return	ToxUserStatus

GetFriendStatusMessage() public method

Retrieves the status message of a friend.

public GetFriendStatusMessage ( int friendNumber ) : string
friendNumber	int	The friend number to retrieve the status message of.
return	string

GetFriendStatusMessage() public method

Retrieves the status message of a friend.

public GetFriendStatusMessage ( int friendNumber, ToxErrorFriendQuery &error ) : string
friendNumber	int	The friend number to retrieve the status message of.
error	ToxErrorFriendQuery
return	string

GetFriendTypingStatus() public method

Retrieves the typing status of a friend.

public GetFriendTypingStatus ( int friendNumber ) : bool
friendNumber	int	The friend number to retrieve the typing status of.
return	bool

GetFriendTypingStatus() public method

Retrieves the typing status of a friend.

public GetFriendTypingStatus ( int friendNumber, ToxErrorFriendQuery &error ) : bool
friendNumber	int	The friend number to retrieve the typing status of.
error	ToxErrorFriendQuery
return	bool

GetGroupMemberCount() public method

Retrieves the number of group members in a group chat.

public GetGroupMemberCount ( int groupNumber ) : int
groupNumber	int	The group to get the member count of.
return	int

GetGroupMemberName() public method

Retrieves the name of a group member.

public GetGroupMemberName ( int groupNumber, int peerNumber ) : string
groupNumber	int	The group that the peer is in.
peerNumber	int	The peer to retrieve the name of.
return	string

GetGroupNames() public method

Retrieves an array of group member names.

public GetGroupNames ( int groupNumber ) : string[]
groupNumber	int	The group to retrieve member names of.
return	string[]

GetGroupPeerPublicKey() public method

Retrieves the public key of a peer.

public GetGroupPeerPublicKey ( int groupNumber, int peerNumber ) : ToxKey
groupNumber	int	The group that the peer is in.
peerNumber	int	The peer to retrieve the public key of.
return	ToxKey

GetGroupTitle() public method

Retrieves the title of a group.

public GetGroupTitle ( int groupNumber ) : string
groupNumber	int	The group to retrieve the title of.
return	string

GetGroupType() public method

Retrieves the type of a group.

public GetGroupType ( int groupNumber ) : ToxGroupType
groupNumber	int	The group to retrieve the type of.
return	ToxGroupType

GetPrivateKey() public method

Retrieves the private key of this Tox instance.

public GetPrivateKey ( ) : ToxKey
return	ToxKey

GetTcpPort() public method

Retrieves the TCP port this instance of Tox is bound to.

public GetTcpPort ( ) : int
return	int

GetTcpPort() public method

Retrieves the TCP port this instance of Tox is bound to.

public GetTcpPort ( ToxErrorGetPort &error ) : int
error	ToxErrorGetPort
return	int

GetUdpPort() public method

Retrieves the UDP port this instance of Tox is bound to.

public GetUdpPort ( ) : int
return	int

GetUdpPort() public method

Retrieves the UDP port this instance of Tox is bound to.

public GetUdpPort ( ToxErrorGetPort &error ) : int
error	ToxErrorGetPort
return	int

InviteFriend() public method

Invites a friend to a group chat.

public InviteFriend ( int friendNumber, int groupNumber ) : bool
friendNumber	int	The friend to invite to a group.
groupNumber	int	The group to invite the friend to.
return	bool

IsFriendOnline() public method

Check whether or not a friend is online.

public IsFriendOnline ( int friendNumber ) : bool
friendNumber	int	The friend number.
return	bool

Iterate() public method

Runs the tox_iterate once in the current thread.

public Iterate ( ) : int
return	int

JoinGroup() public method

Joins a group with the given public key of the group.

public JoinGroup ( int friendNumber, byte data ) : int
friendNumber	int	The friend number we received an invite from.
data	byte	Data obtained from the OnGroupInvite event.
return	int

NewGroup() public method

Creates a new group and retrieves the group number.

public NewGroup ( ) : int
return	int

PeerNumberIsOurs() public method

Check if the given peernumber corresponds to ours.

public PeerNumberIsOurs ( int groupNumber, int peerNumber ) : bool
groupNumber	int	The group to check in.
peerNumber	int	The peer number to check.
return	bool

SendGroupAction() public method

Sends an action to a group.

public SendGroupAction ( int groupNumber, string action ) : bool
groupNumber	int	The group to send the action to.
action	string	The action to send.
return	bool

SendGroupMessage() public method

Sends a message to a group.

public SendGroupMessage ( int groupNumber, string message ) : bool
groupNumber	int	The group to send the message to.
message	string	The message to send.
return	bool

SendMessage() public method

Sends a message to a friend.

public SendMessage ( int friendNumber, string message, ToxMessageType type ) : int
friendNumber	int	The friend number to send the message to.
message	string	The message to be sent. Maximum length:
type	ToxMessageType	The type of this message.
return	int

SendMessage() public method

Sends a message to a friend.

public SendMessage ( int friendNumber, string message, ToxMessageType type, ToxErrorSendMessage &error ) : int
friendNumber	int	The friend number to send the message to.
message	string	The message to be sent. Maximum length:
type	ToxMessageType	The type of this message.
error	ToxErrorSendMessage
return	int

SetGroupTitle() public method

Changes the title of a group.

public SetGroupTitle ( int groupNumber, string title ) : bool
groupNumber	int	The group to change the title of.
title	string	The title to set.
return	bool

SetTypingStatus() public method

Sets the typing status of this Tox instance for a friend.

public SetTypingStatus ( int friendNumber, bool isTyping ) : bool
friendNumber	int	The friend number to set the typing status for.
isTyping	bool	Whether or not we're typing.
return	bool

SetTypingStatus() public method

Sets the typing status of this Tox instance for a friend.

public SetTypingStatus ( int friendNumber, bool isTyping, ToxErrorSetTyping &error ) : bool
friendNumber	int	The friend number to set the typing status for.
isTyping	bool	Whether or not we're typing.
error	ToxErrorSetTyping
return	bool

Start() public method

Starts the main 'tox_iterate' loop at an interval retrieved with 'tox_iteration_interval'. If you want to manage your own loop, use the Iterate method instead.

public Start ( ) : void
return	void

Stop() public method

Stops the main tox_do loop if it's running.

public Stop ( ) : void
return	void

Tox() public method

Initializes a new instance of Tox.

public Tox ( ToxOptions options, ToxData data, ToxEncryptionKey key = null ) : System
options	ToxOptions	The options to initialize this instance of Tox with.
data	ToxData	A byte array containing Tox save data.
key	ToxEncryptionKey	The key to decrypt the given encrypted Tox profile data. If the data is not encrypted, this should be null.
return	System

Tox() public method

Initializes a new instance of Tox. If no secret key is specified, toxcore will generate a new keypair.

public Tox ( ToxOptions options, ToxKey secretKey = null ) : System
options	ToxOptions	The options to initialize this instance of Tox with.
secretKey	ToxKey	Optionally, specify the secret key to initialize this instance of Tox with. Must be ToxConstants.SecretKeySize bytes in size.
return	System