From 31951d08c3e3eeb359e9fdd2302e45c2e6f18462 Mon Sep 17 00:00:00 2001 From: Simon Redman Date: Sat, 12 Sep 2020 14:42:27 -0700 Subject: [PATCH] Update header documentation for PACKET_TYPE_SMS_REQUEST --- plugins/sms/smsplugin.h | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/plugins/sms/smsplugin.h b/plugins/sms/smsplugin.h index 876df8bc..cea4f816 100644 --- a/plugins/sms/smsplugin.h +++ b/plugins/sms/smsplugin.h @@ -76,11 +76,12 @@ * Packet sent to request a message be sent * * The body should look like so: - * { "version": 2, - * "addresses": - * "textMessage": "Hi mom!", - * "attachments": - * "sub_id": "3859358340534" + * { + * "version": 2, // The version of the packet being sent. Compare to SMS_REQUEST_PACKET_VERSION before attempting to handle. + * "addresses": >, // The one or many targets of this message + * "messageBody": "Hi mom!", // Plain-text string to be sent as the body of the message + * "attachments": >,// Send one or more attachments with this message. See AttachmentContainer documentation for formatting. (Optional) + * "sub_id": 3859358340534 // Some magic number which tells Android which SIM card to use (Optional, if omitted, sends with the default SIM card) * } * * An AttachmentContainer object looks like: @@ -93,6 +94,7 @@ */ #define PACKET_TYPE_SMS_REQUEST QStringLiteral("kdeconnect.sms.request") + /** * Packet sent to request the most-recent message in each conversations on the device * -- GitLab