CustomEndpoint

open class CustomEndpoint

Class to interact with a custom endpoint in the backend.


                    
                    
                    CompletionHandler

Completion handler block for execute custom endpoints.

Declaration

Swift

@available(*, deprecated, message: "Deprecated in version 3.17.0. Please use Result<T, Swift.Error> instead")
public typealias CompletionHandler<T> = (T?, Swift.Error?) -> Void


                    
                    
                    execute(_:params:client:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@available(*, deprecated, message: "Deprecated in version 3.17.0. Please use CustomEndpoint.execute(_:params:options:completionHandler:﹚")
@discardableResult
open class func execute(
    _ name: String,
    params: Params? = nil,
    client: Client = sharedClient,
    completionHandler: CompletionHandler<JsonDictionary>? = nil
) -> AnyRequest<Swift.Result<JsonDictionary, Swift.Error>>


                    
                    
                    execute(_:params:client:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@available(*, deprecated, message: "Deprecated in version 3.17.0. Please use CustomEndpoint.execute(_:params:options:completionHandler:﹚")
@discardableResult
open class func execute(
    _ name: String,
    params: Params? = nil,
    client: Client = sharedClient,
    completionHandler: ((Swift.Result<JsonDictionary, Swift.Error>) -> Void)? = nil
) -> AnyRequest<Swift.Result<JsonDictionary, Swift.Error>>


                    
                    
                    execute(_:params:options:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@discardableResult
open class func execute(
    _ name: String,
    params: Params? = nil,
    options: Options? = nil,
    completionHandler: ((Swift.Result<JsonDictionary, Swift.Error>) -> Void)? = nil
) -> AnyRequest<Swift.Result<JsonDictionary, Swift.Error>>


                    
                    
                    execute(_:params:client:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@available(*, deprecated, message: "Deprecated in version 3.17.0. Please use CustomEndpoint.execute(_:params:options:completionHandler:﹚")
@discardableResult
open class func execute(
    _ name: String,
    params: Params? = nil,
    client: Client = sharedClient,
    completionHandler: CompletionHandler<[JsonDictionary]>? = nil
) -> AnyRequest<Swift.Result<[JsonDictionary], Swift.Error>>


                    
                    
                    execute(_:params:client:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@available(*, deprecated, message: "Deprecated in version 3.17.0. Please use CustomEndpoint.execute(_:params:options:completionHandler:﹚")
@discardableResult
open class func execute(
    _ name: String,
    params: Params? = nil,
    client: Client = sharedClient,
    completionHandler: ((Swift.Result<[JsonDictionary], Swift.Error>) -> Void)? = nil
) -> AnyRequest<Swift.Result<[JsonDictionary], Swift.Error>>


                    
                    
                    execute(_:params:options:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@discardableResult
open class func execute(
    _ name: String,
    params: Params? = nil,
    options: Options? = nil,
    completionHandler: ((Swift.Result<[JsonDictionary], Swift.Error>) -> Void)? = nil
) -> AnyRequest<Swift.Result<[JsonDictionary], Swift.Error>>

BaseMappable: Mappable or StaticMappable


                    
                    
                    execute(_:params:client:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@available(*, deprecated, message: "Deprecated in version 3.17.0. Please use CustomEndpoint.execute(_:params:options:completionHandler:﹚")
@discardableResult
open class func execute<T: BaseMappable>(
    _ name: String,
    params: Params? = nil,
    client: Client = sharedClient,
    completionHandler: CompletionHandler<T>? = nil
) -> AnyRequest<Swift.Result<T, Swift.Error>> where T: JSONDecodable


                    
                    
                    execute(_:params:client:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@available(*, deprecated, message: "Deprecated in version 3.17.0. Please use CustomEndpoint.execute(_:params:options:completionHandler:﹚")
@discardableResult
open class func execute<T: BaseMappable>(
    _ name: String,
    params: Params? = nil,
    client: Client = sharedClient,
    completionHandler: ((Swift.Result<T, Swift.Error>) -> Void)? = nil
) -> AnyRequest<Swift.Result<T, Swift.Error>> where T: JSONDecodable


                    
                    
                    execute(_:params:options:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@discardableResult
open class func execute<T>(
    _ name: String,
    params: Params? = nil,
    options: Options? = nil,
    completionHandler: ((Swift.Result<T, Swift.Error>) -> Void)? = nil
) -> AnyRequest<Swift.Result<T, Swift.Error>> where T : JSONDecodable


                    
                    
                    execute(_:params:client:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@available(*, deprecated, message: "Deprecated in version 3.17.0. Please use CustomEndpoint.execute(_:params:options:completionHandler:﹚")
@discardableResult
open class func execute<T: BaseMappable>(
    _ name: String,
    params: Params? = nil,
    client: Client = sharedClient,
    completionHandler: CompletionHandler<[T]>? = nil
) -> AnyRequest<Swift.Result<[T], Swift.Error>> where T: JSONDecodable


                    
                    
                    execute(_:params:client:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@available(*, deprecated, message: "Deprecated in version 3.17.0. Please use CustomEndpoint.execute(_:params:options:completionHandler:﹚")
@discardableResult
open class func execute<T: BaseMappable>(
    _ name: String,
    params: Params? = nil,
    client: Client = sharedClient,
    completionHandler: ((Swift.Result<[T], Swift.Error>) -> Void)? = nil
) -> AnyRequest<Swift.Result<[T], Swift.Error>> where T: JSONDecodable


                    
                    
                    execute(_:params:options:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@discardableResult
open class func execute<T>(
    _ name: String,
    params: Params? = nil,
    options: Options? = nil,
    completionHandler: ((Swift.Result<[T], Swift.Error>) -> Void)? = nil
) -> AnyRequest<Swift.Result<[T], Swift.Error>> where T: JSONDecodable


                    
                    
                    execute(_:params:options:completionHandler:)

Executes a custom endpoint by name and passing the expected parameters.

Declaration

Swift

@discardableResult
open class func execute<T>(
    _ name: String,
    params: Params? = nil,
    options: Options? = nil,
    completionHandler: ((Swift.Result<[T], Swift.Error>) -> Void)? = nil
) -> AnyRequest<Swift.Result<[T], Swift.Error>> where T: Decodable

Params
Parameter Wrapper
See more
Declaration
Swift

open class Params