Return struct instead of object path directly for dbus list devices

[signal-cli] / src / main / java / org / asamk / Signal.java

diff --git a/src/main/java/org/asamk/Signal.java b/src/main/java/org/asamk/Signal.java
index e7a21b88a721bd8d2376a1b6229b7980e2daba10..2f81c196e714950dff561c48586c7e64578d925b 100644 (file)
--- a/src/main/java/org/asamk/Signal.java
+++ b/src/main/java/org/asamk/Signal.java
@@ -1,8 +1,15 @@
 package org.asamk;
 
+import org.asamk.signal.commands.exceptions.IOErrorException;
+
+import org.freedesktop.dbus.DBusPath;
+import org.freedesktop.dbus.Struct;
+import org.freedesktop.dbus.annotations.DBusProperty;
+import org.freedesktop.dbus.annotations.Position;
 import org.freedesktop.dbus.exceptions.DBusException;
 import org.freedesktop.dbus.exceptions.DBusExecutionException;
 import org.freedesktop.dbus.interfaces.DBusInterface;
+import org.freedesktop.dbus.interfaces.Properties;
 import org.freedesktop.dbus.messages.DBusSignal;
 
 import java.util.List;
@@ -13,6 +20,8 @@ import java.util.List;
  */
 public interface Signal extends DBusInterface {
 
+    String getSelfNumber();
+
     long sendMessage(
             String message, List<String> attachments, String recipient
     ) throws Error.AttachmentInvalid, Error.Failure, Error.InvalidNumber, Error.UntrustedIdentity;
@@ -21,6 +30,14 @@ public interface Signal extends DBusInterface {
             String message, List<String> attachments, List<String> recipients
     ) throws Error.AttachmentInvalid, Error.Failure, Error.InvalidNumber, Error.UntrustedIdentity;
 
+    void sendTyping(
+            String recipient, boolean stop
+    ) throws Error.Failure, Error.GroupNotFound, Error.UntrustedIdentity;
+
+    void sendReadReceipt(
+            String recipient, List<Long> messageIds
+    ) throws Error.Failure, Error.UntrustedIdentity;
+
     long sendRemoteDeleteMessage(
             long targetSentTimestamp, String recipient
     ) throws Error.Failure, Error.InvalidNumber;
@@ -31,7 +48,7 @@ public interface Signal extends DBusInterface {
 
     long sendGroupRemoteDeleteMessage(
             long targetSentTimestamp, byte[] groupId
-    ) throws Error.Failure, Error.GroupNotFound;
+    ) throws Error.Failure, Error.GroupNotFound, Error.InvalidGroupId;
 
     long sendMessageReaction(
             String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, String recipient
@@ -41,6 +58,10 @@ public interface Signal extends DBusInterface {
             String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, List<String> recipients
     ) throws Error.InvalidNumber, Error.Failure;
 
+    void sendContacts() throws Error.Failure;
+
+    void sendSyncRequest() throws Error.Failure;
+
     long sendNoteToSelfMessage(
             String message, List<String> attachments
     ) throws Error.AttachmentInvalid, Error.Failure;
@@ -49,51 +70,82 @@ public interface Signal extends DBusInterface {
 
     long sendGroupMessage(
             String message, List<String> attachments, byte[] groupId
-    ) throws Error.GroupNotFound, Error.Failure, Error.AttachmentInvalid;
+    ) throws Error.GroupNotFound, Error.Failure, Error.AttachmentInvalid, Error.InvalidGroupId;
 
     long sendGroupMessageReaction(
             String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, byte[] groupId
-    ) throws Error.GroupNotFound, Error.Failure, Error.InvalidNumber;
+    ) throws Error.GroupNotFound, Error.Failure, Error.InvalidNumber, Error.InvalidGroupId;
 
     String getContactName(String number) throws Error.InvalidNumber;
 
     void setContactName(String number, String name) throws Error.InvalidNumber;
 
+    void setExpirationTimer(final String number, final int expiration) throws Error.Failure;
+
     void setContactBlocked(String number, boolean blocked) throws Error.InvalidNumber;
 
-    void setGroupBlocked(byte[] groupId, boolean blocked) throws Error.GroupNotFound;
+    void setGroupBlocked(byte[] groupId, boolean blocked) throws Error.GroupNotFound, Error.InvalidGroupId;
 
     List<byte[]> getGroupIds();
 
-    String getGroupName(byte[] groupId);
+    String getGroupName(byte[] groupId) throws Error.InvalidGroupId;
 
-    List<String> getGroupMembers(byte[] groupId);
+    List<String> getGroupMembers(byte[] groupId) throws Error.InvalidGroupId;
 
     byte[] updateGroup(
             byte[] groupId, String name, List<String> members, String avatar
-    ) throws Error.AttachmentInvalid, Error.Failure, Error.InvalidNumber, Error.GroupNotFound;
+    ) throws Error.AttachmentInvalid, Error.Failure, Error.InvalidNumber, Error.GroupNotFound, Error.InvalidGroupId;
+
+    boolean isRegistered() throws Error.Failure, Error.InvalidNumber;
+
+    boolean isRegistered(String number) throws Error.Failure, Error.InvalidNumber;
+
+    List<Boolean> isRegistered(List<String> numbers) throws Error.Failure, Error.InvalidNumber;
+
+    void addDevice(String uri) throws Error.InvalidUri;
+
+    DBusPath getDevice(long deviceId);
 
-    boolean isRegistered();
+    List<StructDevice> listDevices() throws Error.Failure;
+
+    DBusPath getThisDevice();
+
+    void updateProfile(
+            String givenName,
+            String familyName,
+            String about,
+            String aboutEmoji,
+            String avatarPath,
+            boolean removeAvatar
+    ) throws Error.Failure;
 
     void updateProfile(
             String name, String about, String aboutEmoji, String avatarPath, boolean removeAvatar
     ) throws Error.Failure;
 
+    void removePin();
+
+    void setPin(String registrationLockPin);
+
     String version();
 
     List<String> listNumbers();
 
     List<String> getContactNumber(final String name) throws Error.Failure;
 
-    void quitGroup(final byte[] groupId) throws Error.GroupNotFound, Error.Failure;
+    void quitGroup(final byte[] groupId) throws Error.GroupNotFound, Error.Failure, Error.InvalidGroupId;
 
     boolean isContactBlocked(final String number) throws Error.InvalidNumber;
 
-    boolean isGroupBlocked(final byte[] groupId);
+    boolean isGroupBlocked(final byte[] groupId) throws Error.InvalidGroupId;
 
-    boolean isMember(final byte[] groupId);
+    boolean isMember(final byte[] groupId) throws Error.InvalidGroupId;
 
-    void joinGroup(final String groupLink) throws Error.Failure;
+    byte[] joinGroup(final String groupLink) throws Error.Failure;
+
+    String uploadStickerPack(String stickerPackPath) throws Error.Failure;
+
+    void submitRateLimitChallenge(String challenge, String captchaString) throws IOErrorException;
 
     class MessageReceived extends DBusSignal {
 
@@ -212,6 +264,45 @@ public interface Signal extends DBusInterface {
         }
     }
 
+    class StructDevice extends Struct {
+
+        @Position(0)
+        DBusPath objectPath;
+
+        @Position(1)
+        Long id;
+
+        @Position(2)
+        String name;
+
+        public StructDevice(final DBusPath objectPath, final Long id, final String name) {
+            this.objectPath = objectPath;
+            this.id = id;
+            this.name = name;
+        }
+
+        public DBusPath getObjectPath() {
+            return objectPath;
+        }
+
+        public Long getId() {
+            return id;
+        }
+
+        public String getName() {
+            return name;
+        }
+    }
+
+    @DBusProperty(name = "Id", type = Long.class, access = DBusProperty.Access.READ)
+    @DBusProperty(name = "Name", type = String.class)
+    @DBusProperty(name = "Created", type = String.class, access = DBusProperty.Access.READ)
+    @DBusProperty(name = "LastSeen", type = String.class, access = DBusProperty.Access.READ)
+    interface Device extends DBusInterface, Properties {
+
+        void removeDevice() throws Error.Failure;
+    }
+
     interface Error {
 
         class AttachmentInvalid extends DBusExecutionException {
@@ -221,6 +312,13 @@ public interface Signal extends DBusInterface {
             }
         }
 
+        class InvalidUri extends DBusExecutionException {
+
+            public InvalidUri(final String message) {
+                super(message);
+            }
+        }
+
         class Failure extends DBusExecutionException {
 
             public Failure(final String message) {
@@ -235,6 +333,13 @@ public interface Signal extends DBusInterface {
             }
         }
 
+        class InvalidGroupId extends DBusExecutionException {
+
+            public InvalidGroupId(final String message) {
+                super(message);
+            }
+        }
+
         class InvalidNumber extends DBusExecutionException {
 
             public InvalidNumber(final String message) {