FileRequest

public class FileRequest: MoltinRequest

An entry point to make API calls relating to File

  • The API endpoint for this resource.

    Declaration

    Swift

    public var endpoint: String = "/files"
  • A typealias which allows automatic casting of a collection to [File].

    Declaration

    Swift

    public typealias DefaultCollectionRequestHandler = CollectionRequestHandler<[File]>
  • A typealias which allows automatic casting of an object to File.

    Declaration

    Swift

    public typealias DefaultObjectRequestHandler = ObjectRequestHandler<File>
  • Return all instances of type File

    Author

    Craig Tweedy

    Declaration

    Swift

    @discardableResult public func all(completionHandler: @escaping DefaultCollectionRequestHandler) -> MoltinRequest

    Parameters

    completionHandler

    The handler to be called on success or failure

    Return Value

    A instance of MoltinRequest which encapsulates the request.

  • Return all instances of type File by id

    Author

    Craig Tweedy

    Declaration

    Swift

    @discardableResult public func get(forID id: String, completionHandler: @escaping DefaultObjectRequestHandler) -> MoltinRequest

    Parameters

    forID

    The ID of the object

    completionHandler

    The handler to be called on success or failure

    Return Value

    A instance of MoltinRequest which encapsulates the request.