APIService Class Reference

client
发送者
Declaration
Swift

public let client: APIClient


                    
                    
                    init(client:)

构造方法

Declaration

Swift

public init(client: APIClient)

Parameters


                                client

发送者实现

Async/Await Support


                    
                    
                    sendRequestAsync(_:plugins:queue:progressHandler:)

异步发送请求

Throws

APIError

Declaration

Swift

public static func sendRequestAsync<T: APIRequest>(
    _ request: T,
    plugins: [APIPlugin] = [],
    queue: DispatchQueue = .main,
    progressHandler: APIProgressHandler? = nil
) async throws -> APIResponse<T.Response>

Parameters

`request`	请求
`plugins`	插件
`queue`	回调队列
`progressHandler`	进度回调

Return Value

请求结果


                    
                    
                    sendRequestSequence(_:plugins:progressHandler:)

异步发送请求 - AsyncSequence版本，支持缓存和网络数据的多次返回会根据缓存策略返回一个或多个结果

Declaration

Swift

public static func sendRequestSequence<T: APIRequest>(
    _ request: T,
    plugins: [APIPlugin] = [],
    progressHandler: APIProgressHandler? = nil
) -> APIResponseAsyncSequence<T.Response>

Parameters

`request`	请求
`plugins`	插件
`progressHandler`	进度回调

Return Value

异步序列，包含数据来源信息


                    
                    
                    sendRequestAsync(_:plugins:queue:progressHandler:)

异步发送请求

Throws

APIError

Declaration

Swift

public func sendRequestAsync<T: APIRequest>(
    _ request: T,
    plugins: [APIPlugin] = [],
    queue: DispatchQueue = .main,
    progressHandler: APIProgressHandler? = nil
) async throws -> APIResponse<T.Response>

Parameters

`request`	请求
`plugins`	插件
`queue`	回调队列
`progressHandler`	进度回调

Return Value

请求结果


                    
                    
                    sendRequestSequence(_:plugins:queue:progressHandler:)

异步发送请求 - 实例方法，AsyncSequence版本

Declaration

Swift

public func sendRequestSequence<T: APIRequest>(
    _ request: T,
    plugins: [APIPlugin] = [],
    queue: DispatchQueue = .main,
    progressHandler: APIProgressHandler? = nil
) -> APIResponseAsyncSequence<T.Response>

Parameters

`request`	请求
`plugins`	插件
`progressHandler`	进度回调

Return Value

异步序列

公开属性


                    
                    
                    networkStatus

网络状态

Declaration

Swift

public var networkStatus: NetworkStatus { get }

isNetworkReachable
网络是否可用
Declaration
Swift

public var isNetworkReachable: Bool { get }

公开方法


                    
                    
                    sendRequest(_:plugins:queue:progressHandler:cacheHandler:completionHandler:)

创建数据请求这种方式使用为 Alamofire 作为底层实现

Declaration

Swift

@discardableResult
public static func sendRequest<T: APIRequest>(
    _ request: T,
    plugins: [APIPlugin] = [],
    queue: DispatchQueue = .main,
    progressHandler: APIProgressHandler? = nil,
    cacheHandler: APICacheCompletionHandler<T.Response>? = nil,
    completionHandler: APICompletionHandler<T.Response>?
) -> APIRequestTask?

Parameters

`request`	请求
`plugins`	插件
`progressHandler`	进度回调
`cacheHandler`	缓存回调
`completionHandler`	网络回调

Return Value

请求任务


                    
                    
                    sendRequest(_:plugins:queue:progressHandler:completionHandler:)

创建数据请求这种方式使用为 Alamofire 作为底层实现

Declaration

Swift

@discardableResult
public static func sendRequest<T: APIRequest>(
    _ request: T,
    plugins: [APIPlugin] = [],
    queue: DispatchQueue = .main,
    progressHandler: APIProgressHandler? = nil,
    completionHandler: APICompletionSourceHandler<T.Response>?
) -> APIRequestTask?

Parameters

`request`	请求
`plugins`	插件
`progressHandler`	进度回调
`completionHandler`	结果回调，包含多种类型

Return Value

请求任务


                    
                    
                    sendRequest(_:plugins:queue:progressHandler:cacheHandler:completionHandler:)

创建数据请求

Declaration

Swift

@discardableResult
public func sendRequest<T: APIRequest>(
    _ request: T,
    plugins: [APIPlugin] = [],
    queue: DispatchQueue = .main,
    progressHandler: APIProgressHandler? = nil,
    cacheHandler: APICacheCompletionHandler<T.Response>? = nil,
    completionHandler: APICompletionHandler<T.Response>?
) -> APIRequestTask?

Parameters

`request`	请求
`plugins`	插件
`progressHandler`	进度回调
`cacheHandler`	命中缓存回调
`completionHandler`	网络回调

Return Value

请求任务