summaryrefslogtreecommitdiff
path: root/protocols/Tox/libtox/src/toxcore/tox.api.h
diff options
context:
space:
mode:
authoraunsane <aunsane@gmail.com>2018-08-17 00:29:59 +0300
committeraunsane <aunsane@gmail.com>2018-08-18 13:08:40 +0300
commit22196f3cad4751f964c56da518bb57ab0e64ae97 (patch)
tree9830ac73ecd5047aaa4ae0f67139b14cb9f8c4d2 /protocols/Tox/libtox/src/toxcore/tox.api.h
parent28d0e917496ecfd681e8cd3e3032519867993f9b (diff)
Tox: libtox updated to v0.2.6
Diffstat (limited to 'protocols/Tox/libtox/src/toxcore/tox.api.h')
-rw-r--r--protocols/Tox/libtox/src/toxcore/tox.api.h39
1 files changed, 38 insertions, 1 deletions
diff --git a/protocols/Tox/libtox/src/toxcore/tox.api.h b/protocols/Tox/libtox/src/toxcore/tox.api.h
index 243606410c..3629bed1b4 100644
--- a/protocols/Tox/libtox/src/toxcore/tox.api.h
+++ b/protocols/Tox/libtox/src/toxcore/tox.api.h
@@ -182,7 +182,7 @@ const VERSION_MINOR = 2;
* The patch or revision number. Incremented when bugfixes are applied without
* changing any functionality or API or ABI.
*/
-const VERSION_PATCH = 5;
+const VERSION_PATCH = 6;
/**
* A macro to check at preprocessing time whether the client code is compatible
@@ -342,6 +342,9 @@ const MAX_HOSTNAME_LENGTH = 255;
/**
* Represents the possible statuses a client can have.
+ *
+ * @deprecated All UPPER_CASE enum type names are deprecated. Use the
+ * Camel_Snake_Case versions, instead.
*/
enum class USER_STATUS {
/**
@@ -364,6 +367,9 @@ enum class USER_STATUS {
/**
* Represents message types for ${tox.friend.send.message} and conference
* messages.
+ *
+ * @deprecated All UPPER_CASE enum type names are deprecated. Use the
+ * Camel_Snake_Case versions, instead.
*/
enum class MESSAGE_TYPE {
/**
@@ -387,6 +393,9 @@ enum class MESSAGE_TYPE {
/**
* Type of proxy used to connect to TCP relays.
+ *
+ * @deprecated All UPPER_CASE enum type names are deprecated. Use the
+ * Camel_Snake_Case versions, instead.
*/
enum class PROXY_TYPE {
/**
@@ -405,6 +414,9 @@ enum class PROXY_TYPE {
/**
* Type of savedata to create the Tox instance from.
+ *
+ * @deprecated All UPPER_CASE enum type names are deprecated. Use the
+ * Camel_Snake_Case versions, instead.
*/
enum class SAVEDATA_TYPE {
/**
@@ -424,6 +436,9 @@ enum class SAVEDATA_TYPE {
/**
* Severity level of log messages.
+ *
+ * @deprecated All UPPER_CASE enum type names are deprecated. Use the
+ * Camel_Snake_Case versions, instead.
*/
enum class LOG_LEVEL {
/**
@@ -813,6 +828,9 @@ bool add_tcp_relay(string host, uint16_t port, const uint8_t[PUBLIC_KEY_SIZE] pu
/**
* Protocols that can be used to connect to the network or friends.
+ *
+ * @deprecated All UPPER_CASE enum type names are deprecated. Use the
+ * Camel_Snake_Case versions, instead.
*/
enum class CONNECTION {
/**
@@ -2104,6 +2122,9 @@ namespace conference {
/**
* Conference types for the ${event invite} event.
+ *
+ * @deprecated All UPPER_CASE enum type names are deprecated. Use the
+ * Camel_Snake_Case versions, instead.
*/
enum class TYPE {
/**
@@ -2136,6 +2157,18 @@ namespace conference {
/**
+ * This event is triggered when the client successfully connects to a
+ * conference after joining it with the $join function.
+ */
+ event connected const {
+ /**
+ * @param conference_number The conference number of the conference to which we have connected.
+ */
+ typedef void(uint32_t conference_number);
+ }
+
+
+ /**
* This event is triggered when the client receives a conference message.
*/
event message const {
@@ -2292,6 +2325,10 @@ namespace conference {
/**
* Invites a friend to a conference.
*
+ * We must be connected to the conference, meaning that the conference has not
+ * been deleted, and either we created the conference with the $new function,
+ * or a `${event connected}` event has occurred for the conference.
+ *
* @param friend_number The friend number of the friend we want to invite.
* @param conference_number The conference number of the conference we want to invite the friend to.
*