nmode's Git Repositories - signal-cli/blob - client/src/jsonrpc.rs

   1 use std::path::Path;
   2
   3 use jsonrpc_client_transports::{transports::ipc, RpcError};
   4 use jsonrpc_core::serde::Deserialize;
   5 use jsonrpc_derive::rpc;
   6 use tokio::net::ToSocketAddrs;
   7
   8 pub type SignalCliClient = gen_client::Client;
   9
  10 #[rpc(client, params = "named")]
  11 pub trait Rpc {
  12     #[rpc(name = "addDevice", params = "named")]
  13     fn add_device(&self, account: Option<String>, uri: String) -> Result<Value>;
  14
  15     #[rpc(name = "block", params = "named")]
  16     fn block(
  17         &self,
  18         account: Option<String>,
  19         recipients: Vec<String>,
  20         #[allow(non_snake_case)] groupIds: Vec<String>,
  21     ) -> Result<Value>;
  22
  23     #[rpc(name = "deleteLocalAccountData", params = "named")]
  24     fn delete_local_account_data(
  25         &self,
  26         account: Option<String>,
  27         #[allow(non_snake_case)] ignoreRegistered: Option<bool>,
  28     ) -> Result<Value>;
  29
  30     #[rpc(name = "getUserStatus", params = "named")]
  31     fn get_user_status(&self, account: Option<String>, recipients: Vec<String>) -> Result<Value>;
  32
  33     #[rpc(name = "joinGroup", params = "named")]
  34     fn join_group(&self, account: Option<String>, uri: String) -> Result<Value>;
  35
  36     #[rpc(name = "finishLink", params = "named")]
  37     fn finish_link(
  38         &self,
  39         #[allow(non_snake_case)] deviceLinkUri: String,
  40         #[allow(non_snake_case)] deviceName: String,
  41     ) -> Result<Value>;
  42
  43     #[rpc(name = "listAccounts", params = "named")]
  44     fn list_accounts(&self) -> Result<Value>;
  45
  46     #[rpc(name = "listContacts", params = "named")]
  47     fn list_contacts(
  48         &self,
  49         account: Option<String>,
  50         recipients: Vec<String>,
  51         #[allow(non_snake_case)] allRecipients: bool,
  52         blocked: Option<bool>,
  53         name: Option<String>,
  54     ) -> Result<Value>;
  55
  56     #[rpc(name = "listDevices", params = "named")]
  57     fn list_devices(&self, account: Option<String>) -> Result<Value>;
  58
  59     #[rpc(name = "listGroups", params = "named")]
  60     fn list_groups(
  61         &self,
  62         account: Option<String>,
  63         #[allow(non_snake_case)] groupIds: Vec<String>,
  64     ) -> Result<Value>;
  65
  66     #[rpc(name = "listIdentities", params = "named")]
  67     fn list_identities(&self, account: Option<String>, number: Option<String>) -> Result<Value>;
  68
  69     #[rpc(name = "listStickerPacks", params = "named")]
  70     fn list_sticker_packs(&self, account: Option<String>) -> Result<Value>;
  71
  72     #[rpc(name = "quitGroup", params = "named")]
  73     fn quit_group(
  74         &self,
  75         account: Option<String>,
  76         #[allow(non_snake_case)] groupId: String,
  77         delete: bool,
  78         admins: Vec<String>,
  79     ) -> Result<Value>;
  80
  81     #[rpc(name = "register", params = "named")]
  82     fn register(
  83         &self,
  84         account: Option<String>,
  85         voice: bool,
  86         captcha: Option<String>,
  87     ) -> Result<Value>;
  88
  89     #[rpc(name = "removeContact", params = "named")]
  90     fn remove_contact(
  91         &self,
  92         account: Option<String>,
  93         recipient: String,
  94         forget: bool,
  95     ) -> Result<Value>;
  96
  97     #[rpc(name = "removeDevice", params = "named")]
  98     fn remove_device(
  99         &self,
 100         account: Option<String>,
 101         #[allow(non_snake_case)] deviceId: u32,
 102     ) -> Result<Value>;
 103
 104     #[rpc(name = "removePin", params = "named")]
 105     fn remove_pin(&self, account: Option<String>) -> Result<Value>;
 106
 107     #[rpc(name = "remoteDelete", params = "named")]
 108     fn remote_delete(
 109         &self,
 110         account: Option<String>,
 111         #[allow(non_snake_case)] targetTimestamp: u64,
 112         recipients: Vec<String>,
 113         #[allow(non_snake_case)] groupIds: Vec<String>,
 114         #[allow(non_snake_case)] noteToSelf: bool,
 115     ) -> Result<Value>;
 116
 117     #[rpc(name = "send", params = "named")]
 118     fn send(
 119         &self,
 120         account: Option<String>,
 121         recipients: Vec<String>,
 122         #[allow(non_snake_case)] groupIds: Vec<String>,
 123         #[allow(non_snake_case)] noteToSelf: bool,
 124         #[allow(non_snake_case)] endSession: bool,
 125         message: String,
 126         attachments: Vec<String>,
 127         mentions: Vec<String>,
 128         #[allow(non_snake_case)] quoteTimestamp: Option<u64>,
 129         #[allow(non_snake_case)] quoteAuthor: Option<String>,
 130         #[allow(non_snake_case)] quoteMessage: Option<String>,
 131         #[allow(non_snake_case)] quoteMention: Vec<String>,
 132         sticker: Option<String>,
 133     ) -> Result<Value>;
 134
 135     #[rpc(name = "sendContacts", params = "named")]
 136     fn send_contacts(&self, account: Option<String>) -> Result<Value>;
 137
 138     #[rpc(name = "sendPaymentNotification", params = "named")]
 139     fn send_payment_notification(
 140         &self,
 141         account: Option<String>,
 142         recipient: String,
 143         receipt: String,
 144         note: String,
 145     ) -> Result<Value>;
 146
 147     #[rpc(name = "sendReaction", params = "named")]
 148     fn send_reaction(
 149         &self,
 150         account: Option<String>,
 151         recipients: Vec<String>,
 152         #[allow(non_snake_case)] groupIds: Vec<String>,
 153         #[allow(non_snake_case)] noteToSelf: bool,
 154         emoji: String,
 155         #[allow(non_snake_case)] targetAuthor: String,
 156         #[allow(non_snake_case)] targetTimestamp: u64,
 157         remove: bool,
 158         story: bool,
 159     ) -> Result<Value>;
 160
 161     #[rpc(name = "sendReceipt", params = "named")]
 162     fn send_receipt(
 163         &self,
 164         account: Option<String>,
 165         recipient: String,
 166         #[allow(non_snake_case)] targetTimestamps: Vec<u64>,
 167         r#type: String,
 168     ) -> Result<Value>;
 169
 170     #[rpc(name = "sendSyncRequest", params = "named")]
 171     fn send_sync_request(&self, account: Option<String>) -> Result<Value>;
 172
 173     #[rpc(name = "sendTyping", params = "named")]
 174     fn send_typing(
 175         &self,
 176         account: Option<String>,
 177         recipients: Vec<String>,
 178         #[allow(non_snake_case)] groupIds: Vec<String>,
 179         stop: bool,
 180     ) -> Result<Value>;
 181
 182     #[rpc(name = "setPin", params = "named")]
 183     fn set_pin(&self, account: Option<String>, pin: String) -> Result<Value>;
 184
 185     #[rpc(name = "submitRateLimitChallenge", params = "named")]
 186     fn submit_rate_limit_challenge(
 187         &self,
 188         account: Option<String>,
 189         challenge: String,
 190         captcha: String,
 191     ) -> Result<Value>;
 192
 193     #[rpc(name = "startLink", params = "named")]
 194     fn start_link(&self, account: Option<String>) -> Result<JsonLink>;
 195
 196     #[rpc(name = "trust", params = "named")]
 197     fn trust(
 198         &self,
 199         account: Option<String>,
 200         recipient: String,
 201         #[allow(non_snake_case)] trustAllKnownKeys: bool,
 202         #[allow(non_snake_case)] verifiedSafetyNumber: Option<String>,
 203     ) -> Result<Value>;
 204
 205     #[rpc(name = "unblock", params = "named")]
 206     fn unblock(
 207         &self,
 208         account: Option<String>,
 209         recipients: Vec<String>,
 210         #[allow(non_snake_case)] groupIds: Vec<String>,
 211     ) -> Result<Value>;
 212
 213     #[rpc(name = "unregister", params = "named")]
 214     fn unregister(
 215         &self,
 216         account: Option<String>,
 217         #[allow(non_snake_case)] deleteAccount: bool,
 218     ) -> Result<Value>;
 219
 220     #[rpc(name = "updateAccount", params = "named")]
 221     fn update_account(
 222         &self,
 223         account: Option<String>,
 224         #[allow(non_snake_case)] deviceName: Option<String>,
 225     ) -> Result<Value>;
 226
 227     #[rpc(name = "updateConfiguration", params = "named")]
 228     fn update_configuration(
 229         &self,
 230         account: Option<String>,
 231         #[allow(non_snake_case)] readReceiptes: Option<bool>,
 232         #[allow(non_snake_case)] unidentifiedDeliveryIndicators: Option<bool>,
 233         #[allow(non_snake_case)] typingIndicators: Option<bool>,
 234         #[allow(non_snake_case)] linkPreviews: Option<bool>,
 235     ) -> Result<Value>;
 236
 237     #[rpc(name = "updateContact", params = "named")]
 238     fn update_contact(
 239         &self,
 240         account: Option<String>,
 241         recipient: String,
 242         name: Option<String>,
 243         expiration: Option<u32>,
 244     ) -> Result<Value>;
 245
 246     #[rpc(name = "updateGroup", params = "named")]
 247     fn update_group(
 248         &self,
 249         account: Option<String>,
 250         #[allow(non_snake_case)] groupId: Option<String>,
 251         name: Option<String>,
 252         description: Option<String>,
 253         avatar: Option<String>,
 254         member: Vec<String>,
 255         #[allow(non_snake_case)] removeMember: Vec<String>,
 256         admin: Vec<String>,
 257         #[allow(non_snake_case)] removeAdmin: Vec<String>,
 258         ban: Vec<String>,
 259         unban: Vec<String>,
 260         #[allow(non_snake_case)] resetLink: bool,
 261         #[allow(non_snake_case)] link: Option<String>,
 262         #[allow(non_snake_case)] setPermissionAddMember: Option<String>,
 263         #[allow(non_snake_case)] setPermissionEditDetails: Option<String>,
 264         #[allow(non_snake_case)] setPermissionSendMessages: Option<String>,
 265         expiration: Option<u32>,
 266     ) -> Result<Value>;
 267
 268     #[rpc(name = "updateProfile", params = "named")]
 269     fn update_profile(
 270         &self,
 271         account: Option<String>,
 272         #[allow(non_snake_case)] givenName: Option<String>,
 273         #[allow(non_snake_case)] familyName: Option<String>,
 274         about: Option<String>,
 275         #[allow(non_snake_case)] aboutEmoji: Option<String>,
 276         #[allow(non_snake_case)] mobileCoinAddress: Option<String>,
 277         avatar: Option<String>,
 278         #[allow(non_snake_case)] removeAvatar: bool,
 279     ) -> Result<Value>;
 280
 281     #[rpc(name = "uploadStickerPack", params = "named")]
 282     fn upload_sticker_pack(&self, account: Option<String>, path: String) -> Result<Value>;
 283
 284     #[rpc(name = "verify", params = "named")]
 285     fn verify(
 286         &self,
 287         account: Option<String>,
 288         #[allow(non_snake_case)] verificationCode: String,
 289         pin: Option<String>,
 290     ) -> Result<Value>;
 291
 292     #[pubsub(
 293         subscription = "receive",
 294         subscribe,
 295         name = "subscribeReceive",
 296         params = "named"
 297     )]
 298     fn subscribe_receive(&self, _: Self::Metadata, _: Subscriber<Value>, account: Option<String>);
 299
 300     #[pubsub(subscription = "receive", unsubscribe, name = "unsubscribeReceive")]
 301     fn unsubscribe_receive(&self, _: Option<Self::Metadata>, _: SubscriptionId) -> Result<bool>;
 302
 303     #[rpc(name = "version")]
 304     fn version(&self) -> Result<Value>;
 305 }
 306
 307 #[derive(Deserialize)]
 308 #[serde(rename_all = "camelCase")]
 309 pub struct JsonLink {
 310     pub device_link_uri: String,
 311 }
 312
 313 pub async fn connect_tcp(tcp: impl ToSocketAddrs) -> Result<SignalCliClient, RpcError> {
 314     super::tcp::connect::<_, SignalCliClient>(tcp).await
 315 }
 316
 317 pub async fn connect_unix(socket_path: impl AsRef<Path>) -> Result<SignalCliClient, RpcError> {
 318     ipc::connect::<_, SignalCliClient>(socket_path).await
 319 }