package org.asamk;
-import org.asamk.signal.manager.AttachmentInvalidException;
-import org.asamk.signal.manager.GroupNotFoundException;
+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 org.whispersystems.signalservice.api.push.exceptions.EncapsulatedExceptions;
-import org.whispersystems.signalservice.api.util.InvalidNumberException;
-import java.io.IOException;
import java.util.List;
+/**
+ * DBus interface for the org.asamk.Signal service.
+ * Including emitted Signals and returned Errors.
+ */
public interface Signal extends DBusInterface {
- long sendMessage(String message, List<String> attachments, String recipient) throws EncapsulatedExceptions, AttachmentInvalidException, IOException, InvalidNumberException;
+ String getSelfNumber();
+
+ 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 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;
+
+ long sendRemoteDeleteMessage(
+ long targetSentTimestamp, List<String> recipients
+ ) throws Error.Failure, Error.InvalidNumber;
+
+ long sendGroupRemoteDeleteMessage(
+ long targetSentTimestamp, byte[] groupId
+ ) throws Error.Failure, Error.GroupNotFound, Error.InvalidGroupId;
+
+ long sendMessageReaction(
+ String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, String recipient
+ ) throws Error.InvalidNumber, Error.Failure;
+
+ long sendMessageReaction(
+ String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, List<String> recipients
+ ) throws Error.InvalidNumber, Error.Failure;
- long sendMessage(String message, List<String> attachments, List<String> recipients) throws EncapsulatedExceptions, AttachmentInvalidException, IOException, InvalidNumberException;
+ void sendContacts() throws Error.Failure;
- void sendEndSessionMessage(List<String> recipients) throws IOException, EncapsulatedExceptions, InvalidNumberException;
+ void sendSyncRequest() throws Error.Failure;
- long sendGroupMessage(String message, List<String> attachments, byte[] groupId) throws EncapsulatedExceptions, GroupNotFoundException, AttachmentInvalidException, IOException;
+ long sendNoteToSelfMessage(
+ String message, List<String> attachments
+ ) throws Error.AttachmentInvalid, Error.Failure;
- String getContactName(String number) throws InvalidNumberException;
+ void sendEndSessionMessage(List<String> recipients) throws Error.Failure, Error.InvalidNumber, Error.UntrustedIdentity;
- void setContactName(String number, String name) throws InvalidNumberException;
+ long sendGroupMessage(
+ String message, List<String> attachments, byte[] groupId
+ ) throws Error.GroupNotFound, Error.Failure, Error.AttachmentInvalid, Error.InvalidGroupId;
- void setContactBlocked(String number, boolean blocked) throws InvalidNumberException;
+ long sendGroupMessageReaction(
+ String emoji, boolean remove, String targetAuthor, long targetSentTimestamp, byte[] groupId
+ ) throws Error.GroupNotFound, Error.Failure, Error.InvalidNumber, Error.InvalidGroupId;
- void setGroupBlocked(byte[] groupId, boolean blocked) throws GroupNotFoundException;
+ 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, Error.InvalidGroupId;
List<byte[]> getGroupIds();
- String getGroupName(byte[] groupId);
+ String getGroupName(byte[] groupId) throws Error.InvalidGroupId;
+
+ 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, 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;
- List<String> getGroupMembers(byte[] groupId);
+ void addDevice(String uri) throws Error.InvalidUri;
- byte[] updateGroup(byte[] groupId, String name, List<String> members, String avatar) throws IOException, EncapsulatedExceptions, GroupNotFoundException, AttachmentInvalidException, InvalidNumberException;
+ 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, Error.InvalidGroupId;
+
+ boolean isContactBlocked(final String number) throws Error.InvalidNumber;
+
+ boolean isGroupBlocked(final byte[] groupId) throws Error.InvalidGroupId;
+
+ boolean isMember(final byte[] groupId) throws Error.InvalidGroupId;
+
+ 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 {
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;
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;
return attachments;
}
}
+
+ 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 {
+
+ public AttachmentInvalid(final String message) {
+ super(message);
+ }
+ }
+
+ class InvalidUri extends DBusExecutionException {
+
+ public InvalidUri(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 InvalidGroupId extends DBusExecutionException {
+
+ public InvalidGroupId(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);
+ }
+ }
+ }
}
git.nmode.ca / signal-cli / blobdiff
