CategoryRequest

public class CategoryRequest: MoltinRequest

An entry point to make API calls relating to Category

  • The API endpoint for this resource.

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    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 Category, cast to type T, which must be Codable.

    Author

    Craig Tweedy

    Declaration

    Swift

    @discardableResult public func all<T: Codable>(completionHandler: @escaping CollectionRequestHandler<[T]>) -> 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 Category 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.

  • Return all instances of type Category by id, cast to type T, which must be Codable.

    Author

    Craig Tweedy

    Declaration

    Swift

    @discardableResult public func get<T: Codable>(forID id: String, completionHandler: @escaping ObjectRequestHandler<T>) -> 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.

  • Return the tree of Category

    Author

    Craig Tweedy

    Declaration

    Swift

    @discardableResult public func tree(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 the tree of Category, cast to type T, which must be Codable.

    Author

    Craig Tweedy

    Declaration

    Swift

    @discardableResult public func tree<T: Codable>(completionHandler: @escaping CollectionRequestHandler<[T]>) -> MoltinRequest

    Parameters

    completionHandler

    The handler to be called on success or failure

    Return Value

    A instance of MoltinRequest which encapsulates the request.