summaryrefslogtreecommitdiff
path: root/libpurple/purplewhiteboard.h
diff options
context:
space:
mode:
authorGary Kramlich <grim@reaperworld.com>2021-09-02 21:28:40 -0500
committerGary Kramlich <grim@reaperworld.com>2021-09-02 21:28:40 -0500
commit2a03afa2b0a7ec79b2e34a762597b7415865e061 (patch)
tree1ab0ca3c17bf6a5732c4eed0e8ff2a3b2cb1c33e /libpurple/purplewhiteboard.h
parent99ac18ff794e4a412d8cc1cc7068c98cf0b5120c (diff)
downloadpidgin-2a03afa2b0a7ec79b2e34a762597b7415865e061.tar.gz
Create PurpleWhiteboardManager for managing whiteboards
Testing Done: Compiled only. Tried to create a silc account, but it dies deep in libsilc. Reviewed at https://reviews.imfreedom.org/r/886/
Diffstat (limited to 'libpurple/purplewhiteboard.h')
-rw-r--r--libpurple/purplewhiteboard.h40
1 files changed, 22 insertions, 18 deletions
diff --git a/libpurple/purplewhiteboard.h b/libpurple/purplewhiteboard.h
index 3548a8d9fe..2a23e7f87b 100644
--- a/libpurple/purplewhiteboard.h
+++ b/libpurple/purplewhiteboard.h
@@ -94,14 +94,14 @@ void purple_whiteboard_set_protocol_ops(PurpleWhiteboard *whiteboard, PurpleWhit
/**
* purple_whiteboard_new:
* @account: A #PurpleAccount instance.
- * @who: Who you're drawing with.
+ * @id: The identifier of the whiteboard.
* @state: The state.
*
* Creates a new whiteboard.
*
* Returns: (transfer full): The new #PurpleWhiteboard instance.
*/
-PurpleWhiteboard *purple_whiteboard_new(PurpleAccount *account, const gchar *who, gint state);
+PurpleWhiteboard *purple_whiteboard_new(PurpleAccount *account, const gchar *id, gint state);
/**
* purple_whiteboard_get_account:
@@ -114,14 +114,16 @@ PurpleWhiteboard *purple_whiteboard_new(PurpleAccount *account, const gchar *who
PurpleAccount *purple_whiteboard_get_account(PurpleWhiteboard *whiteboard);
/**
- * purple_whiteboard_get_who:
+ * purple_whiteboard_get_id:
* @whiteboard: The #PurpleWhiteboard instance.
*
- * Gets the name of who you're drawing with.
+ * Gets the id of @whiteboard.
*
- * Returns: The name of who you're drawing with.
+ * Returns: The id of @whiteboard.
+ *
+ * Since: 3.0.0
*/
-const gchar *purple_whiteboard_get_who(PurpleWhiteboard *whiteboard);
+const gchar *purple_whiteboard_get_id(PurpleWhiteboard *whiteboard);
/**
* purple_whiteboard_set_state:
@@ -151,18 +153,6 @@ gint purple_whiteboard_get_state(PurpleWhiteboard *whiteboard);
void purple_whiteboard_start(PurpleWhiteboard *whiteboard);
/**
- * purple_whiteboard_get_session:
- * @account: A #PurpleAccount instance.
- * @who: The name of the user you're drawing with.
- *
- * Finds a whiteboard from @account and @who.
- *
- * Returns: (transfer none): The #PurpleWhiteboard instance if found, otherwise
- * %NULL.
- */
-PurpleWhiteboard *purple_whiteboard_get_session(PurpleAccount *account, const gchar *who);
-
-/**
* purple_whiteboard_draw_list_destroy:
* @draw_list: (element-type gint): The drawing list.
*
@@ -313,6 +303,20 @@ void purple_whiteboard_set_protocol_data(PurpleWhiteboard *whiteboard, gpointer
*/
gpointer purple_whiteboard_get_protocol_data(PurpleWhiteboard *whiteboard);
+/**
+ * purple_whiteboard_equal:
+ * @whiteboard1: The first #PurpleWhiteboard instance to check.
+ * @whiteboard2: The second #PurpleWhiteboard instance to check.
+ *
+ * Checks the id's for @whiteboard1 and @whiteboard2 and return whether or not
+ * they are equal.
+ *
+ * Returns: %TRUE if the id's of @whiteboard1 and @whiteboard2 are equal.
+ *
+ * Since: 3.0.0
+ */
+gboolean purple_whiteboard_equal(PurpleWhiteboard *whiteboard1, PurpleWhiteboard *whiteboard2);
+
G_END_DECLS
#endif /* PURPLE_WHITEBOARD_H */