Implement SetUnread

Author: Desnoo

…/connection/messenger/entity/Favour.java …nnection/messenger/entity/SetAction.javalibrary/src/main/java/com/proxerme/library/connection/messenger/entity/Favour.java renamed to library/src/main/java/com/proxerme/library/connection/messenger/entity/SetAction.java library/src/main/java/com/proxerme/library/connection/messenger/entity/Favour.java renamed to library/src/main/java/com/proxerme/library/connection/messenger/entity/SetAction.java

@@ -5,22 +5,28 @@
 import android.support.annotation.NonNull;
 
 /**
- * The respone class used by {@link com.proxerme.library.connection.messenger.request.SetFavourRequest}
- * and GetFavour
+ * This class is general class to match a simple request with an id.
+ *
+ * Use the this class with {@link com.proxerme.library.connection.messenger.request.SetFavourRequest},
+ * {@link com.proxerme.library.connection.messenger.request.SetUnfavourRequest},
+ * {@link com.proxerme.library.connection.messenger.request.SetBlockRequest},
+ * {@link com.proxerme.library.connection.messenger.request.SetUnblockRequest} or
+ * {@link com.proxerme.library.connection.messenger.request.SetUnreadRequest}.
+ *
  *
  * @author Desnoo
  */
-public class Favour implements Parcelable {
+public class SetAction implements Parcelable {
 
-    public static final Creator<Favour> CREATOR = new Creator<Favour>() {
+    public static final Creator<SetAction> CREATOR = new Creator<SetAction>() {
         @Override
-        public Favour createFromParcel(Parcel in) {
-            return new Favour(in);
+        public SetAction createFromParcel(Parcel in) {
+            return new SetAction(in);
         }
 
         @Override
-        public Favour[] newArray(int size) {
-            return new Favour[size];
+        public SetAction[] newArray(int size) {
+            return new SetAction[size];
         }
     };
 
@@ -31,7 +37,7 @@ public Favour[] newArray(int size) {
      *
      * @param status The status of the response of the request.
      */
-    public Favour(@NonNull String status) {
+    public SetAction(@NonNull String status) {
         this.status = status;
     }
 
@@ -40,15 +46,15 @@ public Favour(@NonNull String status) {
      *
      * @param in The parcel to parse.
      */
-    protected Favour(Parcel in) {
+    protected SetAction(Parcel in) {
         status = in.readString();
     }
 
 
     /**
      * Get the status of the {@link com.proxerme.library.connection.messenger.request.SetFavourRequest}.
      *
-     * @return A string containing the status of the favor request.
+     * @return A string containing the status of a set request.
      */
     @NonNull
     public String getStatus() {
@@ -71,9 +77,9 @@ public boolean equals(Object o) {
         if (this == o) return true;
         if (o == null || getClass() != o.getClass()) return false;
 
-        Favour favour = (Favour) o;
+        SetAction setAction = (SetAction) o;
 
-        return status.equals(favour.status);
+        return status.equals(setAction.status);
 
     }
 

library/src/main/java/com/proxerme/library/connection/messenger/request/SetBlockRequest.java

@@ -0,0 +1,73 @@
+package com.proxerme.library.connection.messenger.request;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+
+import com.afollestad.bridge.Form;
+import com.afollestad.bridge.Response;
+import com.proxerme.library.connection.ProxerRequest;
+import com.proxerme.library.connection.messenger.result.SetActionResult;
+import com.proxerme.library.info.ProxerTag;
+import com.proxerme.library.info.ProxerUrlHolder;
+
+/**
+ * The class that represents the SetBlockRequest. Use this to block a conference.
+ *
+ * @author Desnoo
+ */
+public class SetBlockRequest extends ProxerRequest<SetActionResult> {
+
+    private static final String SET_BLOCK_URL = "/api/v1/messenger/setblock";
+    private static final String CONFERENCE_ID = "conference_id";
+
+    private String conferenceId;
+
+
+    /**
+     * Package constructor.
+     */
+    SetBlockRequest() {
+    }
+
+    /**
+     * The constructor.
+     *
+     * @param conferenceId The conference id of the conference to block.
+     */
+    public SetBlockRequest(@NonNull String conferenceId) {
+        this.conferenceId = conferenceId;
+    }
+
+    /**
+     * Returns the id of the conference.
+     *
+     * @return The conference id.
+     */
+    @NonNull
+    public String getConferenceId() {
+        return conferenceId;
+    }
+
+    @Override
+    protected int getTag() {
+        return ProxerTag.MESSENGER_SET_UNFAVOUR;
+    }
+
+    @Override
+    protected SetActionResult parse(@NonNull Response response) throws Exception {
+        return response.asClass(SetActionResult.class);
+    }
+
+    @NonNull
+    @Override
+    protected String getURL() {
+        return ProxerUrlHolder.getHost() + SET_BLOCK_URL;
+    }
+
+    @Nullable
+    @Override
+    protected Form getBody() {
+        return new Form()
+                .add(CONFERENCE_ID, conferenceId);
+    }
+}

library/src/main/java/com/proxerme/library/connection/messenger/request/SetFavourRequest.java

@@ -6,7 +6,7 @@
 import com.afollestad.bridge.Form;
 import com.afollestad.bridge.Response;
 import com.proxerme.library.connection.ProxerRequest;
-import com.proxerme.library.connection.messenger.result.FavourResult;
+import com.proxerme.library.connection.messenger.result.SetActionResult;
 import com.proxerme.library.info.ProxerTag;
 import com.proxerme.library.info.ProxerUrlHolder;
 
@@ -15,7 +15,7 @@
  *
  * @author Desnoo
  */
-public class SetFavourRequest extends ProxerRequest<FavourResult> {
+public class SetFavourRequest extends ProxerRequest<SetActionResult> {
 
     private static final String SET_FAVOUR_URL = "/api/v1/messenger/setfavour";
     private static final String CONFERENCE_ID = "conference_id";
@@ -54,8 +54,8 @@ protected int getTag() {
     }
 
     @Override
-    protected FavourResult parse(@NonNull Response response) throws Exception {
-        return response.asClass(FavourResult.class);
+    protected SetActionResult parse(@NonNull Response response) throws Exception {
+        return response.asClass(SetActionResult.class);
     }
 
     @NonNull

library/src/main/java/com/proxerme/library/connection/messenger/request/SetUnblockRequest.java

@@ -0,0 +1,73 @@
+package com.proxerme.library.connection.messenger.request;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+
+import com.afollestad.bridge.Form;
+import com.afollestad.bridge.Response;
+import com.proxerme.library.connection.ProxerRequest;
+import com.proxerme.library.connection.messenger.result.SetActionResult;
+import com.proxerme.library.info.ProxerTag;
+import com.proxerme.library.info.ProxerUrlHolder;
+
+/**
+ * The class that represents the SetUnblockRequest. Use this to unblock a conference.
+ *
+ * @author Desnoo
+ */
+public class SetUnblockRequest extends ProxerRequest<SetActionResult> {
+
+    private static final String SET_UNBLOCK_URL = "/api/v1/messenger/setunblock";
+    private static final String CONFERENCE_ID = "conference_id";
+
+    private String conferenceId;
+
+
+    /**
+     * Package constructor.
+     */
+    SetUnblockRequest() {
+    }
+
+    /**
+     * The constructor.
+     *
+     * @param conferenceId The conference id of the conference to unblock.
+     */
+    public SetUnblockRequest(@NonNull String conferenceId) {
+        this.conferenceId = conferenceId;
+    }
+
+    /**
+     * Returns the id of the conference.
+     *
+     * @return The conference id.
+     */
+    @NonNull
+    public String getConferenceId() {
+        return conferenceId;
+    }
+
+    @Override
+    protected int getTag() {
+        return ProxerTag.MESSENGER_SET_UNFAVOUR;
+    }
+
+    @Override
+    protected SetActionResult parse(@NonNull Response response) throws Exception {
+        return response.asClass(SetActionResult.class);
+    }
+
+    @NonNull
+    @Override
+    protected String getURL() {
+        return ProxerUrlHolder.getHost() + SET_UNBLOCK_URL;
+    }
+
+    @Nullable
+    @Override
+    protected Form getBody() {
+        return new Form()
+                .add(CONFERENCE_ID, conferenceId);
+    }
+}

library/src/main/java/com/proxerme/library/connection/messenger/request/SetUnfavourRequest.java

@@ -6,7 +6,7 @@
 import com.afollestad.bridge.Form;
 import com.afollestad.bridge.Response;
 import com.proxerme.library.connection.ProxerRequest;
-import com.proxerme.library.connection.messenger.result.FavourResult;
+import com.proxerme.library.connection.messenger.result.SetActionResult;
 import com.proxerme.library.info.ProxerTag;
 import com.proxerme.library.info.ProxerUrlHolder;
 
@@ -16,7 +16,7 @@
  *
  * @author Desnoo
  */
-public class SetUnfavourRequest extends ProxerRequest<FavourResult> {
+public class SetUnfavourRequest extends ProxerRequest<SetActionResult> {
 
     private static final String SET_UNFAVOUR_URL = "/api/v1/messenger/setunfavour";
     private static final String CONFERENCE_ID = "conference_id";
@@ -54,8 +54,8 @@ protected int getTag() {
     }
 
     @Override
-    protected FavourResult parse(@NonNull Response response) throws Exception {
-        return response.asClass(FavourResult.class);
+    protected SetActionResult parse(@NonNull Response response) throws Exception {
+        return response.asClass(SetActionResult.class);
     }
 
     @NonNull

library/src/main/java/com/proxerme/library/connection/messenger/request/SetUnreadRequest.java

@@ -0,0 +1,73 @@
+package com.proxerme.library.connection.messenger.request;
+
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+
+import com.afollestad.bridge.Form;
+import com.afollestad.bridge.Response;
+import com.proxerme.library.connection.ProxerRequest;
+import com.proxerme.library.connection.messenger.result.SetActionResult;
+import com.proxerme.library.info.ProxerTag;
+import com.proxerme.library.info.ProxerUrlHolder;
+
+/**
+ * The class that represents the SetUnreadRequest. Use this to mark a conference as not read.
+ *
+ * @author Desnoo
+ */
+public class SetUnreadRequest extends ProxerRequest<SetActionResult> {
+
+    private static final String SET_UNREAD_URL = "/api/v1/messenger/setunread";
+    private static final String CONFERENCE_ID = "conference_id";
+
+    private String conferenceId;
+
+
+    /**
+     * Package constructor.
+     */
+    SetUnreadRequest() {
+    }
+
+    /**
+     * The constructor.
+     *
+     * @param conferenceId The conference id of the conference to mark as unread.
+     */
+    public SetUnreadRequest(@NonNull String conferenceId) {
+        this.conferenceId = conferenceId;
+    }
+
+    /**
+     * Returns the id of the conference.
+     *
+     * @return The conference id.
+     */
+    @NonNull
+    public String getConferenceId() {
+        return conferenceId;
+    }
+
+    @Override
+    protected int getTag() {
+        return ProxerTag.MESSENGER_SET_UNFAVOUR;
+    }
+
+    @Override
+    protected SetActionResult parse(@NonNull Response response) throws Exception {
+        return response.asClass(SetActionResult.class);
+    }
+
+    @NonNull
+    @Override
+    protected String getURL() {
+        return ProxerUrlHolder.getHost() + SET_UNREAD_URL;
+    }
+
+    @Nullable
+    @Override
+    protected Form getBody() {
+        return new Form()
+                .add(CONFERENCE_ID, conferenceId);
+    }
+}