Package com.pubnub.api.services

Interface FilesService

  • public interface FilesService

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String GET_FILE_URL  

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      retrofit2.Call<java.lang.Void> deleteFile​(java.lang.String subKey, java.lang.String channel, java.lang.String fileId, java.lang.String fileName, java.util.Map<java.lang.String,​java.lang.String> options)  
      retrofit2.Call<okhttp3.ResponseBody> downloadFile​(java.lang.String subKey, java.lang.String channel, java.lang.String fileId, java.lang.String fileName, java.util.Map<java.lang.String,​java.lang.String> options)  
      retrofit2.Call<GeneratedUploadUrlResponse> generateUploadUrl​(java.lang.String subKey, java.lang.String channel, GenerateUploadUrlPayload body, java.util.Map<java.lang.String,​java.lang.String> options)  
      retrofit2.Call<ListFilesResult> listFiles​(java.lang.String subKey, java.lang.String channel, java.util.Map<java.lang.String,​java.lang.String> options)  
      retrofit2.Call<java.util.List<java.lang.Object>> notifyAboutFileUpload​(java.lang.String pubKey, java.lang.String subKey, java.lang.String channel, java.lang.String message, java.util.Map<java.lang.String,​java.lang.String> options)  

    • Method Detail

      • generateUploadUrl

        @POST("/v1/files/{subKey}/channels/{channel}/generate-upload-url")
retrofit2.Call<GeneratedUploadUrlResponse> generateUploadUrl​(@Path("subKey")
                                                             java.lang.String subKey,
                                                             @Path("channel")
                                                             java.lang.String channel,
                                                             @Body
                                                             GenerateUploadUrlPayload body,
                                                             @QueryMap(encoded=true)
                                                             java.util.Map<java.lang.String,​java.lang.String> options)

      • notifyAboutFileUpload

        @GET("/v1/files/publish-file/{pubKey}/{subKey}/0/{channel}/0/{message}")
retrofit2.Call<java.util.List<java.lang.Object>> notifyAboutFileUpload​(@Path("pubKey")
                                                                       java.lang.String pubKey,
                                                                       @Path("subKey")
                                                                       java.lang.String subKey,
                                                                       @Path("channel")
                                                                       java.lang.String channel,
                                                                       @Path(value="message",encoded=true)
                                                                       java.lang.String message,
                                                                       @QueryMap(encoded=true)
                                                                       java.util.Map<java.lang.String,​java.lang.String> options)

      • listFiles

        @GET("/v1/files/{subKey}/channels/{channel}/files")
retrofit2.Call<ListFilesResult> listFiles​(@Path("subKey")
                                          java.lang.String subKey,
                                          @Path("channel")
                                          java.lang.String channel,
                                          @QueryMap(encoded=true)
                                          java.util.Map<java.lang.String,​java.lang.String> options)

      • downloadFile

        @GET("/v1/files/{subKey}/channels/{channel}/files/{fileId}/{fileName}")
retrofit2.Call<okhttp3.ResponseBody> downloadFile​(@Path("subKey")
                                                  java.lang.String subKey,
                                                  @Path("channel")
                                                  java.lang.String channel,
                                                  @Path("fileId")
                                                  java.lang.String fileId,
                                                  @Path("fileName")
                                                  java.lang.String fileName,
                                                  @QueryMap(encoded=true)
                                                  java.util.Map<java.lang.String,​java.lang.String> options)

      • deleteFile

        @DELETE("/v1/files/{subKey}/channels/{channel}/files/{fileId}/{fileName}")
retrofit2.Call<java.lang.Void> deleteFile​(@Path("subKey")
                                          java.lang.String subKey,
                                          @Path("channel")
                                          java.lang.String channel,
                                          @Path("fileId")
                                          java.lang.String fileId,
                                          @Path("fileName")
                                          java.lang.String fileName,
                                          @QueryMap(encoded=true)
                                          java.util.Map<java.lang.String,​java.lang.String> options)