summaryrefslogtreecommitdiff
path: root/telepathy-glib/file-transfer-channel.c
diff options
context:
space:
mode:
authorJonny Lamb <jonny.lamb@collabora.co.uk>2011-11-14 15:20:43 +0000
committerJonny Lamb <jonny.lamb@collabora.co.uk>2011-11-14 16:05:08 +0000
commitaeec485234085d2fe78d2cad3f62f62f19ed1ac3 (patch)
tree2481d90272178710bb8d10c43e2f7e09eb2b5faf /telepathy-glib/file-transfer-channel.c
parent392eb1b4eee3b2af25497f89949347d2a3b8161f (diff)
downloadtelepathy-glib-aeec485234085d2fe78d2cad3f62f62f19ed1ac3.tar.gz
ft-channel: add example of request channel with metadata
Signed-off-by: Jonny Lamb <jonny.lamb@collabora.co.uk>
Diffstat (limited to 'telepathy-glib/file-transfer-channel.c')
-rw-r--r--telepathy-glib/file-transfer-channel.c27
1 files changed, 27 insertions, 0 deletions
diff --git a/telepathy-glib/file-transfer-channel.c b/telepathy-glib/file-transfer-channel.c
index 651920248..585946d7b 100644
--- a/telepathy-glib/file-transfer-channel.c
+++ b/telepathy-glib/file-transfer-channel.c
@@ -939,6 +939,33 @@ tp_file_transfer_channel_class_init (TpFileTransferChannelClass *klass)
* initiator, or an empty #GHashTable if the initiator did not
* provide any additional information.
*
+ * To provide metadata along with a file offer, include
+ * %TP_PROP_CHANNEL_INTERFACE_FILE_TRANSFER_METADATA_METADATA in the
+ * channel request. For example:
+ *
+ * |[
+ * GHashTable *request;
+ * GHashTable *metadata = g_hash_table_new (g_str_hash, g_str_equal);
+ * const gchar * const values[] = { "Jason Derulo", "Tinie Tempah", NULL };
+ *
+ * g_hash_table_insert (metadata, "best buds", values);
+ *
+ * request = tp_asv_new (
+ * TP_PROP_CHANNEL_CHANNEL_TYPE, G_TYPE_STRING, TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER,
+ * TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, G_TYPE_UINT, TP_HANDLE_TYPE_CONTACT,
+ * TP_PROP_CHANNEL_TARGET_ID, G_TYPE_STRING, "foo@bar.com",
+ * TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_CONTENT_TYPE, G_TYPE_STRING, "text/plain",
+ * TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_DATE, G_TYPE_INT64, 1320925992,
+ * TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_DESCRIPTION, G_TYPE_STRING, "",
+ * TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_FILENAME, G_TYPE_STRING, "test.pdf",
+ * TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_INITIAL_OFFSET, G_TYPE_UINT64, 0,
+ * TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_SIZE, G_TYPE_UINT64, 165710,
+ * TP_PROP_CHANNEL_INTERFACE_FILE_TRANSFER_METADATA_METADATA, TP_TYPE_METADATA, metadata,
+ * NULL);
+ *
+ * ...
+ * ]|
+ *
* The %TP_FILE_TRANSFER_CHANNEL_FEATURE_CORE feature has to be
* prepared for this property to be meaningful.
*