CXAN-462 Add editComment API (#624)

* CXAN-462 Add editComment API
vimeo · Jul 20, 2023 · 2edfee2 · 2edfee2
1 parent 4671ef6
commit 2edfee2
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 1 deletion.
diff --git a/request/src/main/java/com/vimeo/networking2/VimeoApiClient.kt b/request/src/main/java/com/vimeo/networking2/VimeoApiClient.kt
@@ -885,6 +885,23 @@ interface VimeoApiClient {
         timeCode: Double? = null,
     ): VimeoRequest
 
+    /**
+     * Edit a [Comment].
+     *
+     * @param uri The URI of the [Comment] to edit.
+     * @param text The optional new text for the comment.
+     * @param timeCode The optional time code of the video this comment relates to.
+     * @param callback The callback which will be notified of the request completion.
+     *
+     * @return A [VimeoRequest] object to cancel API requests.
+     */
+    fun editComment(
+        uri: String,
+        text: String? = null,
+        timeCode: Double? = null,
+        callback: VimeoCallback<Comment>
+    ): VimeoRequest
+
     /**
      * Create a note on a [Video].
      *

diff --git a/request/src/main/java/com/vimeo/networking2/VimeoService.kt b/request/src/main/java/com/vimeo/networking2/VimeoService.kt
@@ -215,6 +215,15 @@ internal interface VimeoService {
         @Field(PARAMETER_TIME_CODE) timeCode: Double?,
     ): VimeoCall<Comment>
 
+    @FormUrlEncoded
+    @PATCH
+    fun editComment(
+        @Header(AUTHORIZATION) authorization: String,
+        @Url uri: String,
+        @Field(PARAMETER_COMMENT_TEXT_BODY) commentBody: String?,
+        @Field(PARAMETER_TIME_CODE) timeCode: Double?,
+    ): VimeoCall<Comment>
+
     @POST
     fun createNote(
         @Header(AUTHORIZATION) authorization: String,

diff --git a/request/src/main/java/com/vimeo/networking2/internal/MutableVimeoApiClientDelegate.kt b/request/src/main/java/com/vimeo/networking2/internal/MutableVimeoApiClientDelegate.kt
@@ -671,7 +671,7 @@ internal class MutableVimeoApiClientDelegate(var actual: VimeoApiClient? = null)
         password: String?,
         callback: VimeoCallback<Comment>,
         timeCode: Double?
-    ): VimeoRequest = client.createComment(uri, comment, password, callback, timeCode,)
+    ): VimeoRequest = client.createComment(uri, comment, password, callback, timeCode)
 
     override fun createComment(
         video: Video,
@@ -681,6 +681,13 @@ internal class MutableVimeoApiClientDelegate(var actual: VimeoApiClient? = null)
         timeCode: Double?
     ): VimeoRequest = client.createComment(video, comment, password, callback, timeCode)
 
+    override fun editComment(
+        uri: String,
+        text: String?,
+        timeCode: Double?,
+        callback: VimeoCallback<Comment>
+    ): VimeoRequest = client.editComment(uri, text, timeCode, callback)
+
     override fun createNote(
         uri: String,
         text: String,

diff --git a/request/src/main/java/com/vimeo/networking2/internal/VimeoApiClientImpl.kt b/request/src/main/java/com/vimeo/networking2/internal/VimeoApiClientImpl.kt
@@ -1301,6 +1301,16 @@ internal class VimeoApiClientImpl(
         return createComment(uri, comment, password, callback, timeCode)
     }
 
+    override fun editComment(
+        uri: String,
+        text: String?,
+        timeCode: Double?,
+        callback: VimeoCallback<Comment>,
+    ): VimeoRequest {
+        val safeUri = uri.validate() ?: return localVimeoCallAdapter.enqueueInvalidUri(callback)
+        return vimeoService.editComment(authHeader, safeUri, text, timeCode).enqueue(callback)
+    }
+
     override fun createNote(
         uri: String,
         text: String,