Endpoint

open class Endpoint

Class for reifying a target of the Target enum unto a concrete Endpoint.

Note

As of Moya 11.0.0 Endpoint is no longer generic. Existing code should work as is after removing the generic. See #1529 and #1524 for the discussion.


                    
                    
                    SampleResponseClosure

Undocumented

Declaration

Swift

public typealias SampleResponseClosure = () -> EndpointSampleResponse

url
A string representation of the URL for the request.
Declaration
Swift

public let url: String
sampleResponseClosure
A closure responsible for returning an EndpointSampleResponse.
Declaration
Swift

public let sampleResponseClosure: SampleResponseClosure
method
The HTTP method for the request.
Declaration
Swift

public let method: Moya.Method
task
The Task for the request.
Declaration
Swift

public let task: Task
httpHeaderFields
The HTTP header fields for the request.
Declaration
Swift

public let httpHeaderFields: [String : String]?


                    
                    
                    init(url:sampleResponseClosure:method:task:httpHeaderFields:)

Undocumented

Declaration

Swift

public init(url: String,
            sampleResponseClosure: @escaping SampleResponseClosure,
            method: Moya.Method,
            task: Task,
            httpHeaderFields: [String: String]?)

adding(newHTTPHeaderFields:)
Convenience method for creating a new Endpoint with the same properties as the receiver, but with added HTTP header fields.
Declaration
Swift

open func adding(newHTTPHeaderFields: [String : String]) -> Endpoint
replacing(task:)
Convenience method for creating a new Endpoint with the same properties as the receiver, but with replaced task parameter.
Declaration
Swift

open func replacing(task: Task) -> Endpoint

urlRequest()
Returns the Endpoint converted to a URLRequest if valid. Throws an error otherwise.
Declaration
Swift

func urlRequest() throws -> URLRequest


                    
                    
                    hash(into:)

Declaration

Swift

public func hash(into hasher: inout Hasher)

==(_:_:)
Note: If both Endpoints fail to produce a URLRequest the comparison will fall back to comparing each Endpoint’s hashValue.
Declaration
Swift

public static func == (lhs: Endpoint, rhs: Endpoint) -> Bool