summaryrefslogtreecommitdiff
path: root/toxcore/tox.api.h
diff options
context:
space:
mode:
Diffstat (limited to 'toxcore/tox.api.h')
-rw-r--r--toxcore/tox.api.h35
1 files changed, 26 insertions, 9 deletions
diff --git a/toxcore/tox.api.h b/toxcore/tox.api.h
index 732262f1..39b457ea 100644
--- a/toxcore/tox.api.h
+++ b/toxcore/tox.api.h
@@ -2232,7 +2232,7 @@ namespace conference {
2232 /** 2232 /**
2233 * Creates a new conference. 2233 * Creates a new conference.
2234 * 2234 *
2235 * This function creates a new text conference. 2235 * This function creates and connects to a new text conference.
2236 * 2236 *
2237 * @return conference number on success, or an unspecified value on failure. 2237 * @return conference number on success, or an unspecified value on failure.
2238 */ 2238 */
@@ -2279,7 +2279,10 @@ namespace conference {
2279 namespace peer { 2279 namespace peer {
2280 2280
2281 /** 2281 /**
2282 * Return the number of peers in the conference. Return value is unspecified on failure. 2282 * Return the number of online peers in the conference. The unsigned
2283 * integers less than this number are the valid values of peer_number for
2284 * the functions querying these peers. Return value is unspecified on
2285 * failure.
2283 */ 2286 */
2284 const uint32_t count(uint32_t conference_number) 2287 const uint32_t count(uint32_t conference_number)
2285 with error for peer_query; 2288 with error for peer_query;
@@ -2327,7 +2330,9 @@ namespace conference {
2327 namespace offline_peer { 2330 namespace offline_peer {
2328 2331
2329 /** 2332 /**
2330 * Return the number of offline peers in the conference. Return value is unspecified on failure. 2333 * Return the number of offline peers in the conference. The unsigned
2334 * integers less than this number are the valid values of offline_peer_number for
2335 * the functions querying these peers. Return value is unspecified on failure.
2331 */ 2336 */
2332 const uint32_t count(uint32_t conference_number) 2337 const uint32_t count(uint32_t conference_number)
2333 with error for peer_query; 2338 with error for peer_query;
@@ -2388,10 +2393,6 @@ namespace conference {
2388 /** 2393 /**
2389 * Invites a friend to a conference. 2394 * Invites a friend to a conference.
2390 * 2395 *
2391 * We must be connected to the conference, meaning that the conference has not
2392 * been deleted, and either we created the conference with the $new function,
2393 * or a `${event connected}` event has occurred for the conference.
2394 *
2395 * @param friend_number The friend number of the friend we want to invite. 2396 * @param friend_number The friend number of the friend we want to invite.
2396 * @param conference_number The conference number of the conference we want to invite the friend to. 2397 * @param conference_number The conference number of the conference we want to invite the friend to.
2397 * 2398 *
@@ -2416,6 +2417,14 @@ namespace conference {
2416 /** 2417 /**
2417 * Joins a conference that the client has been invited to. 2418 * Joins a conference that the client has been invited to.
2418 * 2419 *
2420 * After successfully joining the conference, the client will not be "connected"
2421 * to it until a handshaking procedure has been completed. A
2422 * `${event connected}` event will then occur for the conference. The client
2423 * will then remain connected to the conference until the conference is deleted,
2424 * even across core restarts. Many operations on a conference will fail with a
2425 * corresponding error if attempted on a conference to which the client is not
2426 * yet connected.
2427 *
2419 * @param friend_number The friend number of the friend who sent the invite. 2428 * @param friend_number The friend number of the friend who sent the invite.
2420 * @param cookie Received via the `${event invite}` event. 2429 * @param cookie Received via the `${event invite}` event.
2421 * @param length The size of cookie. 2430 * @param length The size of cookie.
@@ -2552,8 +2561,16 @@ namespace conference {
2552 size(); 2561 size();
2553 2562
2554 /** 2563 /**
2555 * Copy a list of valid conference IDs into the array chatlist. Determine how much space 2564 * Copy a list of valid conference numbers into the array chatlist. Determine
2556 * to allocate for the array with the `$size` function. 2565 * how much space to allocate for the array with the `$size` function.
2566 *
2567 * Note that `${savedata.get}` saves all connected conferences;
2568 * when toxcore is created from savedata in which conferences were saved, those
2569 * conferences will be connected at startup, and will be listed by
2570 * `$get`.
2571 *
2572 * The conference number of a loaded conference may differ from the conference
2573 * number it had when it was saved.
2557 */ 2574 */
2558 get(); 2575 get();
2559 } 2576 }