Packages

class FileApi extends CirceSchema

Linear Supertypes
CirceSchema, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileApi
  2. CirceSchema
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new FileApi(baseUrl: String)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit val AnyFormat: Encoder[Any] with Decoder[Any]
    Definition Classes
    CirceSchema
  5. implicit val ConfigFormat: Encoder[MongoCampConfiguration]
    Definition Classes
    CirceSchema
  6. implicit val DateFormat: Encoder[Date] with Decoder[Date]
    Definition Classes
    CirceSchema
  7. implicit val DateTimeFormat: Encoder[DateTime] with Decoder[DateTime]
    Definition Classes
    CirceSchema
  8. implicit val MapStringAnyFormat: Encoder[Map[String, Any]] with Decoder[Map[String, Any]]
    Definition Classes
    CirceSchema
  9. implicit val ObjectIdFormat: Encoder[ObjectId] with Decoder[ObjectId]
    Definition Classes
    CirceSchema
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  12. def decodeFromJson(json: Json): Any
    Definition Classes
    CirceSchema
  13. def deleteFile(username: String, password: String, bearerToken: String, apiKey: String)(bucketName: String, fileId: String): RequestT[Identity, Either[ResponseException[String, Error], DeleteResponse], Any with Any]

    Delete one File from given Bucket

    Delete one File from given Bucket

    Expected answers: code 200 : DeleteResponse () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    bucketName

    The name of your MongoDb Collection

    fileId

    fileId to delete

  14. def encodeAnyToJson(a: Any, deepth: Int): Json
    Definition Classes
    CirceSchema
  15. def encodeMapStringAny(a: Map[String, Any]): Json
    Definition Classes
    CirceSchema
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. def findFiles(username: String, password: String, bearerToken: String, apiKey: String)(bucketName: String, mongoFindRequest: MongoFindRequest, rowsPerPage: Option[Long] = None, page: Option[Long] = None): RequestT[Identity, Either[ResponseException[String, Error], Seq[FileInformation]], Any with Any]

    Alternative to GET Route for more complex queries and URL max.

    Alternative to GET Route for more complex queries and URL max. Length

    Expected answers: code 200 : Seq[FileInformation] () Headers : x-pagination-count-rows - count all elements x-pagination-rows-per-page - Count elements per page x-pagination-current-page - Current page x-pagination-count-pages - Count pages code 400 : String (Invalid value for: body, Invalid value for: query parameter rowsPerPage, Invalid value for: query parameter page) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    bucketName

    The name of your MongoDb Collection

    rowsPerPage

    Count elements per page

    page

    Requested page of the ResultSets

  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  20. def getFile(username: String, password: String, bearerToken: String, apiKey: String)(bucketName: String, fileId: String, file: File): RequestT[Identity, Either[String, File], Any with Any]

    Get File from given Bucket

    Get File from given Bucket

    Expected answers: code 200 : File () Headers : Content-Length - Content-Disposition - Content-Type - cache-control - code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    bucketName

    The name of your MongoDb Collection

    fileId

    FileId to read

  21. def getFileInformation(username: String, password: String, bearerToken: String, apiKey: String)(bucketName: String, fileId: String): RequestT[Identity, Either[ResponseException[String, Error], FileInformation], Any with Any]

    Get one FileInformation from given Bucket

    Get one FileInformation from given Bucket

    Expected answers: code 200 : FileInformation () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    bucketName

    The name of your MongoDb Collection

    fileId

    fileId to read

  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  23. def insertFile(username: String, password: String, bearerToken: String, apiKey: String)(bucketName: String, file: File, metaData: String, fileName: Option[String] = None): RequestT[Identity, Either[ResponseException[String, Error], InsertResponse], Any with Any]

    Insert one File in given Bucket

    Insert one File in given Bucket

    Expected answers: code 200 : InsertResponse () code 400 : String (Invalid value for: body, Invalid value for: query parameter fileName) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    bucketName

    The name of your MongoDb Collection

    fileName

    override filename of uploaded file

  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def listFiles(username: String, password: String, bearerToken: String, apiKey: String)(bucketName: String, filter: Option[String] = None, sort: Option[String] = None, projection: Option[String] = None, rowsPerPage: Option[Long] = None, page: Option[Long] = None): RequestT[Identity, Either[ResponseException[String, Error], Seq[FileInformation]], Any with Any]

    Get Files paginated from given Bucket

    Get Files paginated from given Bucket

    Expected answers: code 200 : Seq[FileInformation] () Headers : x-pagination-count-rows - count all elements x-pagination-rows-per-page - Count elements per page x-pagination-current-page - Current page x-pagination-count-pages - Count pages code 400 : String (Invalid value for: query parameter filter, Invalid value for: query parameter sort, Invalid value for: query parameter projection, Invalid value for: query parameter rowsPerPage, Invalid value for: query parameter page) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    bucketName

    The name of your MongoDb Collection

    filter

    MongoDB Filter Query by Default all filter

    sort

    MongoDB sorting

    projection

    MongoDB projection

    rowsPerPage

    Count elements per page

    page

    Requested page of the ResultSets

  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  29. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. def updateFileInformation(username: String, password: String, bearerToken: String, apiKey: String)(bucketName: String, fileId: String, updateFileInformationRequest: UpdateFileInformationRequest): RequestT[Identity, Either[ResponseException[String, Error], UpdateResponse], Any with Any]

    Replace MetaData and potential update FileName

    Replace MetaData and potential update FileName

    Expected answers: code 200 : UpdateResponse () code 400 : String (Invalid value for: body) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    bucketName

    The name of your MongoDb Collection

    fileId

    fileId to update

  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from CirceSchema

Inherited from AnyRef

Inherited from Any

Ungrouped