View on GitHub
CollectionRequest Class Reference
CollectionRequest
public class CollectionRequest : MoltinRequestAn entry point to make API calls relating to Collection
-
The API endpoint for this resource.
Declaration
Swift
public var endpoint: String -
A typealias which allows automatic casting of a collection to
[Collection].Declaration
Swift
public typealias DefaultCollectionRequestHandler = CollectionRequestHandler<[Collection]> -
A typealias which allows automatic casting of an object to
Collection.Declaration
Swift
public typealias DefaultObjectRequestHandler = ObjectRequestHandler<Collection> -
Return all instances of type
CollectionDeclaration
Swift
@discardableResult public func all(completionHandler: @escaping DefaultCollectionRequestHandler) -> MoltinRequestParameters
completionHandlerThe handler to be called on success or failure
Return Value
A instance of
MoltinRequestwhich encapsulates the request. -
Return all instances of type
Collection, cast to typeT, which must beCodable.Declaration
Swift
@discardableResult public func all<T: Codable>(completionHandler: @escaping CollectionRequestHandler<[T]>) -> MoltinRequestParameters
completionHandlerThe handler to be called on success or failure
Return Value
A instance of
MoltinRequestwhich encapsulates the request. -
Return all instances of type
CollectionbyidDeclaration
Swift
@discardableResult public func get(forID id: String, completionHandler: @escaping DefaultObjectRequestHandler) -> MoltinRequestParameters
forIDThe ID of the object
completionHandlerThe handler to be called on success or failure
Return Value
A instance of
MoltinRequestwhich encapsulates the request. -
Return all instances of type
Collectionbyid, cast to typeT, which must beCodable.Declaration
Swift
@discardableResult public func get<T: Codable>(forID id: String, completionHandler: @escaping ObjectRequestHandler<T>) -> MoltinRequestParameters
forIDThe ID of the object
completionHandlerThe handler to be called on success or failure
Return Value
A instance of
MoltinRequestwhich encapsulates the request. -
Return the tree of
CollectionDeclaration
Swift
@discardableResult public func tree(completionHandler: @escaping DefaultCollectionRequestHandler) -> MoltinRequestParameters
completionHandlerThe handler to be called on success or failure
Return Value
A instance of
MoltinRequestwhich encapsulates the request. -
Return the tree of
Collection, cast to typeT, which must beCodable.Declaration
Swift
@discardableResult public func tree<T: Codable>(completionHandler: @escaping CollectionRequestHandler<[T]>) -> MoltinRequestParameters
completionHandlerThe handler to be called on success or failure
Return Value
A instance of
MoltinRequestwhich encapsulates the request.