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     ) -> Result<Value>;
 159
 160     #[rpc(name = "sendReceipt", params = "named")]
 161     fn send_receipt(
 162         &self,
 163         account: Option<String>,
 164         recipient: String,
 165         #[allow(non_snake_case)] targetTimestamps: Vec<u64>,
 166         r#type: String,
 167     ) -> Result<Value>;
 168
 169     #[rpc(name = "sendSyncRequest", params = "named")]
 170     fn send_sync_request(&self, account: Option<String>) -> Result<Value>;
 171
 172     #[rpc(name = "sendTyping", params = "named")]
 173     fn send_typing(
 174         &self,
 175         account: Option<String>,
 176         recipients: Vec<String>,
 177         #[allow(non_snake_case)] groupIds: Vec<String>,
 178         stop: bool,
 179     ) -> Result<Value>;
 180
 181     #[rpc(name = "setPin", params = "named")]
 182     fn set_pin(&self, account: Option<String>, pin: String) -> Result<Value>;
 183
 184     #[rpc(name = "submitRateLimitChallenge", params = "named")]
 185     fn submit_rate_limit_challenge(
 186         &self,
 187         account: Option<String>,
 188         challenge: String,
 189         captcha: String,
 190     ) -> Result<Value>;
 191
 192     #[rpc(name = "startLink", params = "named")]
 193     fn start_link(&self, account: Option<String>) -> Result<JsonLink>;
 194
 195     #[rpc(name = "trust", params = "named")]
 196     fn trust(
 197         &self,
 198         account: Option<String>,
 199         recipient: String,
 200         #[allow(non_snake_case)] trustAllKnownKeys: bool,
 201         #[allow(non_snake_case)] verifiedSafetyNumber: Option<String>,
 202     ) -> Result<Value>;
 203
 204     #[rpc(name = "unblock", params = "named")]
 205     fn unblock(
 206         &self,
 207         account: Option<String>,
 208         recipients: Vec<String>,
 209         #[allow(non_snake_case)] groupIds: Vec<String>,
 210     ) -> Result<Value>;
 211
 212     #[rpc(name = "unregister", params = "named")]
 213     fn unregister(
 214         &self,
 215         account: Option<String>,
 216         #[allow(non_snake_case)] deleteAccount: bool,
 217     ) -> Result<Value>;
 218
 219     #[rpc(name = "updateAccount", params = "named")]
 220     fn update_account(
 221         &self,
 222         account: Option<String>,
 223         #[allow(non_snake_case)] deviceName: Option<String>,
 224     ) -> Result<Value>;
 225
 226     #[rpc(name = "updateConfiguration", params = "named")]
 227     fn update_configuration(
 228         &self,
 229         account: Option<String>,
 230         #[allow(non_snake_case)] readReceiptes: Option<bool>,
 231         #[allow(non_snake_case)] unidentifiedDeliveryIndicators: Option<bool>,
 232         #[allow(non_snake_case)] typingIndicators: Option<bool>,
 233         #[allow(non_snake_case)] linkPreviews: Option<bool>,
 234     ) -> Result<Value>;
 235
 236     #[rpc(name = "updateContact", params = "named")]
 237     fn update_contact(
 238         &self,
 239         account: Option<String>,
 240         recipient: String,
 241         name: Option<String>,
 242         expiration: Option<u32>,
 243     ) -> Result<Value>;
 244
 245     #[rpc(name = "updateGroup", params = "named")]
 246     fn update_group(
 247         &self,
 248         account: Option<String>,
 249         #[allow(non_snake_case)] groupId: Option<String>,
 250         name: Option<String>,
 251         description: Option<String>,
 252         avatar: Option<String>,
 253         member: Vec<String>,
 254         #[allow(non_snake_case)] removeMember: Vec<String>,
 255         admin: Vec<String>,
 256         #[allow(non_snake_case)] removeAdmin: Vec<String>,
 257         ban: Vec<String>,
 258         unban: Vec<String>,
 259         #[allow(non_snake_case)] resetLink: bool,
 260         #[allow(non_snake_case)] link: Option<String>,
 261         #[allow(non_snake_case)] setPermissionAddMember: Option<String>,
 262         #[allow(non_snake_case)] setPermissionEditDetails: Option<String>,
 263         #[allow(non_snake_case)] setPermissionSendMessages: Option<String>,
 264         expiration: Option<u32>,
 265     ) -> Result<Value>;
 266
 267     #[rpc(name = "updateProfile", params = "named")]
 268     fn update_profile(
 269         &self,
 270         account: Option<String>,
 271         #[allow(non_snake_case)] givenName: Option<String>,
 272         #[allow(non_snake_case)] familyName: Option<String>,
 273         about: Option<String>,
 274         #[allow(non_snake_case)] aboutEmoji: Option<String>,
 275         #[allow(non_snake_case)] mobileCoinAddress: Option<String>,
 276         avatar: Option<String>,
 277         #[allow(non_snake_case)] removeAvatar: bool,
 278     ) -> Result<Value>;
 279
 280     #[rpc(name = "uploadStickerPack", params = "named")]
 281     fn upload_sticker_pack(&self, account: Option<String>, path: String) -> Result<Value>;
 282
 283     #[rpc(name = "verify", params = "named")]
 284     fn verify(
 285         &self,
 286         account: Option<String>,
 287         #[allow(non_snake_case)] verificationCode: String,
 288         pin: Option<String>,
 289     ) -> Result<Value>;
 290
 291     #[pubsub(
 292         subscription = "receive",
 293         subscribe,
 294         name = "subscribeReceive",
 295         params = "named"
 296     )]
 297     fn subscribe_receive(&self, _: Self::Metadata, _: Subscriber<Value>, account: Option<String>);
 298
 299     #[pubsub(subscription = "receive", unsubscribe, name = "unsubscribeReceive")]
 300     fn unsubscribe_receive(&self, _: Option<Self::Metadata>, _: SubscriptionId) -> Result<bool>;
 301
 302     #[rpc(name = "version")]
 303     fn version(&self) -> Result<Value>;
 304 }
 305
 306 #[derive(Deserialize)]
 307 #[serde(rename_all = "camelCase")]
 308 pub struct JsonLink {
 309     pub device_link_uri: String,
 310 }
 311
 312 pub async fn connect_tcp(tcp: impl ToSocketAddrs) -> Result<SignalCliClient, RpcError> {
 313     super::tcp::connect::<_, SignalCliClient>(tcp).await
 314 }
 315
 316 pub async fn connect_unix(socket_path: impl AsRef<Path>) -> Result<SignalCliClient, RpcError> {
 317     ipc::connect::<_, SignalCliClient>(socket_path).await
 318 }