Dbus sendreaction doc (#591)

[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 c1acf13edfb8a3dce10878cebdd3c041310e0230..f8841da95b73321a16644e85730c8d71ed15cc99 100644 (file)
--- a/src/main/java/org/asamk/Signal.java
+++ b/src/main/java/org/asamk/Signal.java
@@ -1,33 +1,55 @@
 package org.asamk;
 
 package org.asamk;
 

-import org.asamk.signal.manager.AttachmentInvalidException;
-import org.asamk.signal.manager.GroupNotFoundException;

 import org.freedesktop.dbus.exceptions.DBusException;
 import org.freedesktop.dbus.exceptions.DBusException;

+import org.freedesktop.dbus.exceptions.DBusExecutionException;

 import org.freedesktop.dbus.interfaces.DBusInterface;
 import org.freedesktop.dbus.messages.DBusSignal;
 import org.freedesktop.dbus.interfaces.DBusInterface;
 import org.freedesktop.dbus.messages.DBusSignal;

-import org.whispersystems.signalservice.api.push.exceptions.EncapsulatedExceptions;
-import org.whispersystems.signalservice.api.util.InvalidNumberException;

 
 

-import java.io.IOException;

 import java.util.List;
 
 import java.util.List;
 

+/**
+ * DBus interface for the org.asamk.Signal service.
+ * Including emitted Signals and returned Errors.
+ */

 public interface Signal extends DBusInterface {
 
 public interface Signal extends DBusInterface {
 

-    long sendMessage(String message, List<String> attachments, String recipient) throws EncapsulatedExceptions, AttachmentInvalidException, IOException, InvalidNumberException;
+    long sendMessage(
+            String message, List<String> attachments, String recipient
+    ) throws Error.AttachmentInvalid, Error.Failure, Error.InvalidNumber, Error.UntrustedIdentity;

 
 

-    long sendMessage(String message, List<String> attachments, List<String> recipients) throws EncapsulatedExceptions, AttachmentInvalidException, IOException, InvalidNumberException;
+    long sendMessage(
+            String message, List<String> attachments, List<String> recipients
+    ) throws Error.AttachmentInvalid, Error.Failure, Error.InvalidNumber, Error.UntrustedIdentity;

 
 

-    void sendEndSessionMessage(List<String> recipients) throws IOException, EncapsulatedExceptions, InvalidNumberException;
+    long sendMessageReaction(
+            String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, String recipient
+    ) throws Error.InvalidNumber, Error.Failure;

 
 

-    long sendGroupMessage(String message, List<String> attachments, byte[] groupId) throws EncapsulatedExceptions, GroupNotFoundException, AttachmentInvalidException, IOException;
+    long sendMessageReaction(
+            String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, List<String> recipients
+    ) throws Error.InvalidNumber, Error.Failure;

 
 

-    String getContactName(String number) throws InvalidNumberException;
+    long sendNoteToSelfMessage(
+            String message, List<String> attachments
+    ) throws Error.AttachmentInvalid, Error.Failure;

 
 

-    void setContactName(String number, String name) throws InvalidNumberException;
+    void sendEndSessionMessage(List<String> recipients) throws Error.Failure, Error.InvalidNumber, Error.UntrustedIdentity;

 
 

-    void setContactBlocked(String number, boolean blocked) throws InvalidNumberException;
+    long sendGroupMessage(
+            String message, List<String> attachments, byte[] groupId
+    ) throws Error.GroupNotFound, Error.Failure, Error.AttachmentInvalid;

 
 

-    void setGroupBlocked(byte[] groupId, boolean blocked) throws GroupNotFoundException;
+    long sendGroupMessageReaction(
+            String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, byte[] groupId
+    ) throws Error.GroupNotFound, Error.Failure, Error.InvalidNumber;
+
+    String getContactName(String number) throws Error.InvalidNumber;
+
+    void setContactName(String number, String name) throws Error.InvalidNumber;
+
+    void setContactBlocked(String number, boolean blocked) throws Error.InvalidNumber;
+
+    void setGroupBlocked(byte[] groupId, boolean blocked) throws Error.GroupNotFound;

 
     List<byte[]> getGroupIds();
 
 
     List<byte[]> getGroupIds();
 


@@ -35,10 +57,32 @@ public interface Signal extends DBusInterface {
 
     List<String> getGroupMembers(byte[] groupId);
 
 
     List<String> getGroupMembers(byte[] groupId);
 

-    byte[] updateGroup(byte[] groupId, String name, List<String> members, String avatar) throws IOException, EncapsulatedExceptions, GroupNotFoundException, AttachmentInvalidException, InvalidNumberException;
+    byte[] updateGroup(
+            byte[] groupId, String name, List<String> members, String avatar
+    ) throws Error.AttachmentInvalid, Error.Failure, Error.InvalidNumber, Error.GroupNotFound;

 
     boolean isRegistered();
 
 
     boolean isRegistered();
 

+    void updateProfile(
+            String name, String about, String aboutEmoji, String avatarPath, boolean removeAvatar
+    ) throws Error.Failure;
+
+    String version();
+
+    List<String> listNumbers();
+
+    List<String> getContactNumber(final String name) throws Error.Failure;
+
+    void quitGroup(final byte[] groupId) throws Error.GroupNotFound, Error.Failure;
+
+    boolean isContactBlocked(final String number);
+
+    boolean isGroupBlocked(final byte[] groupId);
+
+    boolean isMember(final byte[] groupId);
+
+    void joinGroup(final String groupLink) throws Error.Failure;
+

     class MessageReceived extends DBusSignal {
 
         private final long timestamp;
     class MessageReceived extends DBusSignal {
 
         private final long timestamp;


@@ -47,7 +91,14 @@ public interface Signal extends DBusInterface {
         private final String message;
         private final List<String> attachments;
 
         private final String message;
         private final List<String> attachments;
 

-        public MessageReceived(String objectpath, long timestamp, String sender, byte[] groupId, String message, List<String> attachments) throws DBusException {
+        public MessageReceived(
+                String objectpath,
+                long timestamp,
+                String sender,
+                byte[] groupId,
+                String message,
+                List<String> attachments
+        ) throws DBusException {

             super(objectpath, timestamp, sender, groupId, message, attachments);
             this.timestamp = timestamp;
             this.sender = sender;
             super(objectpath, timestamp, sender, groupId, message, attachments);
             this.timestamp = timestamp;
             this.sender = sender;


@@ -106,7 +157,15 @@ public interface Signal extends DBusInterface {
         private final String message;
         private final List<String> attachments;
 
         private final String message;
         private final List<String> attachments;
 

-        public SyncMessageReceived(String objectpath, long timestamp, String source, String destination, byte[] groupId, String message, List<String> attachments) throws DBusException {
+        public SyncMessageReceived(
+                String objectpath,
+                long timestamp,
+                String source,
+                String destination,
+                byte[] groupId,
+                String message,
+                List<String> attachments
+        ) throws DBusException {

             super(objectpath, timestamp, source, destination, groupId, message, attachments);
             this.timestamp = timestamp;
             this.source = source;
             super(objectpath, timestamp, source, destination, groupId, message, attachments);
             this.timestamp = timestamp;
             this.source = source;


@@ -140,4 +199,42 @@ public interface Signal extends DBusInterface {
             return attachments;
         }
     }
             return attachments;
         }
     }

+
+    interface Error {
+
+        class AttachmentInvalid extends DBusExecutionException {
+
+            public AttachmentInvalid(final String message) {
+                super(message);
+            }
+        }
+
+        class Failure extends DBusExecutionException {
+
+            public Failure(final String message) {
+                super(message);
+            }
+        }
+
+        class GroupNotFound extends DBusExecutionException {
+
+            public GroupNotFound(final String message) {
+                super(message);
+            }
+        }
+
+        class InvalidNumber extends DBusExecutionException {
+
+            public InvalidNumber(final String message) {
+                super(message);
+            }
+        }
+
+        class UntrustedIdentity extends DBusExecutionException {
+
+            public UntrustedIdentity(final String message) {
+                super(message);
+            }
+        }
+    }

 }
 }