APIManager

public class APIManager

extension APIManager: RequestInterceptor

Main class of framework, which allow to play with the 4D rest api.

instance
Default instance of Self which use URL.qmobile as base url
Declaration
Swift

public static var instance: APIManager { get set }


                    
                    
                    delegate

Delegates.

Declaration

Swift

public weak var delegate: APIManagerDelegate?

Alias


                    
                    
                    Completion

Alias for network completion request callback.

Declaration

Swift

public typealias Completion = (Result<Moya.Response, APIError>) -> Swift.Void

ProgressHandler
Alias for network progression request callback.
Declaration
Swift

public typealias ProgressHandler = Moya.ProgressBlock


                    
                    
                    ConfigureRecordsRequest

Alias to customize records request

Declaration

Swift

public typealias ConfigureRecordsRequest = (RecordsRequest) -> Void

Init

init(url:)
Create an api manager using server URL
Declaration
Swift

public init(url: URL)

Targets

base
Target for all rest request.
Declaration
Swift

public let base: BaseTarget
webTest
Target to get info from web server
Declaration
Swift

public let webTest: WebTestTarget
webTestInfo
Lattest info from server
Declaration
Swift

public var webTestInfo: WebTestInfo?

Authentication


                    
                    
                    authToken

Token for authentication

Declaration

Swift

public var authToken: AuthToken? { get set }

isSignIn
Return if api shared instance has valid token ie. we are logged
Declaration
Swift

public static var isSignIn: Bool { get }
removeAuthToken()
Remove auth token from keychain.
Declaration
Swift

public static func removeAuthToken()

testing

stub
Activate stub response for test.
Declaration
Swift

public var stub: Bool
stubDelegate
A delegate to customize stub feature to test.
Declaration
Swift

public weak var stubDelegate: StubDelegate?

attributes

networkLogLevel
Log level for network. By default .verbose. Pref key: api.network.logLevel
Declaration
Swift

public lazy var networkLogLevel: LogLevel { get set }
plugins
List of Moya plugins.
Declaration
Swift

public var plugins: [PluginType]
defaultQueue
Undocumented
Declaration
Swift

public var defaultQueue: DispatchQueue?
configuration
URL session configuration. Configure timeout, and other properties
Declaration
Swift

public lazy var configuration: URLSessionConfiguration { get set }

configuration functions

serverTrustManager()
Return the ServerTrustManager
Declaration
Swift

open func serverTrustManager() -> ServerTrustManager?
session()
Create a moya Session
Declaration
Swift

open func session() -> Moya.Session
initPlugins()
Undocumented
Declaration
Swift

open func initPlugins()


                    
                    
                    CompletionApplicationInfoHandler

Undocumented

Declaration

Swift

public typealias CompletionApplicationInfoHandler = ((Result<ApplicationInfo, APIError>) -> Void)


                    
                    
                    loadApplicationInfo(actionName:bundleId:callbackQueue:completionHandler:)

Get server status

Declaration

Swift

public func loadApplicationInfo(actionName: String = "mdm_application", bundleId: String, callbackQueue: DispatchQueue? = nil, completionHandler: @escaping CompletionApplicationInfoHandler) -> Cancellable


                    
                    
                    CompletionActionHandler

Call mobile action by name.

Declaration

Swift

public typealias CompletionActionHandler = ((Result<ActionResult, APIError>) -> Void)


                    
                    
                    action(name:parameters:encodeParameters:httpMethod:callbackQueue:progress:completionHandler:)

Undocumented

Declaration

Swift

public func action(name: String,
                   parameters: ActionParameters = [:],
                   encodeParameters: Bool = true,
                   httpMethod: Moya.Method = ActionAbstractTarget.defaultMethod,
                   callbackQueue: DispatchQueue? = nil,
                   progress: ProgressHandler? = nil,
                   completionHandler: @escaping CompletionActionHandler) -> Cancellable


                    
                    
                    action(_:parameters:httpMethod:callbackQueue:progress:completionHandler:)

Call mobile action.

Declaration

Swift

public func action(_ action: Action,
                   parameters: ActionParameters = [:],
                   httpMethod: Moya.Method = ActionAbstractTarget.defaultMethod,
                   callbackQueue: DispatchQueue? = nil,
                   progress: ProgressHandler? = nil,
                   completionHandler: @escaping CompletionActionHandler) -> Cancellable


                    
                    
                    action(_:httpMethod:callbackQueue:progress:completionHandler:)

Call mobile action request.

Declaration

Swift

public func action(_ request: ActionRequest,
                   httpMethod: Moya.Method = ActionAbstractTarget.defaultMethod,
                   callbackQueue: DispatchQueue? = nil,
                   progress: ProgressHandler? = nil,
                   completionHandler: @escaping CompletionActionHandler) -> Cancellable


                    
                    
                    CompletionAuthTokenHandler

Undocumented

Declaration

Swift

public typealias CompletionAuthTokenHandler = ((Result<AuthToken, APIError>) -> Void)


                    
                    
                    authentificate(login:password:send:parameters:callbackQueue:progress:completionHandler:)

Authentificate with login and password.

Declaration

Swift

open func authentificate(login: String,
                         password: String? = nil,
                         send: AuthTarget.Send = .link,
                         parameters: [String: Any]? = nil,
                         callbackQueue: DispatchQueue? = nil,
                         progress: ProgressHandler? = nil,
                         completionHandler: @escaping CompletionAuthTokenHandler) -> Cancellable


                    
                    
                    authentificate(token:callbackQueue:progress:completionHandler:)

Authentificate with token.

Declaration

Swift

open func authentificate(token: String,
                         callbackQueue: DispatchQueue? = nil,
                         progress: ProgressHandler? = nil,
                         completionHandler: @escaping CompletionAuthTokenHandler) -> Cancellable


                    
                    
                    CompletionLogOutHandler

Logout using token in headers or passed token.

Declaration

Swift

public typealias CompletionLogOutHandler = ((Result<Status, APIError>) -> Void)


                    
                    
                    logout(token:callbackQueue:progress:completionHandler:)

Undocumented

Declaration

Swift

open func logout(token: String? = nil,
                 callbackQueue: DispatchQueue? = nil,
                 progress: ProgressHandler? = nil,
                 completionHandler: @escaping CompletionLogOutHandler) -> Cancellable


                    
                    
                    status(callbackQueue:progress:)

Get server status

Declaration

Swift

func status(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<Status, APIError>


                    
                    
                    info(callbackQueue:progress:)

Get server info

Declaration

Swift

func info(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<Info, APIError>


                    
                    
                    sessionInfo(callbackQueue:progress:)

Get server session info

Declaration

Swift

func sessionInfo(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<[SessionInfo], APIError>


                    
                    
                    progressInfo(callbackQueue:progress:)

Get server Progress Info

Declaration

Swift

func progressInfo(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<[ProgressInfo], APIError>


                    
                    
                    cacheInfo(callbackQueue:progress:)

Get server Cache Info

Declaration

Swift

func cacheInfo(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<[CacheInfo], APIError>


                    
                    
                    entitySetInfo(callbackQueue:progress:)

Get server Entity Set Info

Declaration

Swift

func entitySetInfo(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<EntitySetInfo, APIError>


                    
                    
                    catalog(callbackQueue:progress:)

Get the catalog, list description of URI for tables and records

Declaration

Swift

func catalog(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<[Catalog], APIError>


                    
                    
                    tables(callbackQueue:progress:)

Get all tables

Declaration

Swift

func tables(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<[Table], APIError>


                    
                    
                    table(name:callbackQueue:progress:)

Get one table by name @param table the wanted table name

Declaration

Swift

func table(name: String, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<Table, APIError>


                    
                    
                    deletedRecordPage(configure:callbackQueue:progress:)

Get deleted records

Declaration

Swift

func deletedRecordPage(configure: ConfigureRecordsRequest? = nil, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<Page, APIError>

upload(data:image:mimeType:callbackQueue:progress:)
Upload data to the server. Could be an image or a blob. An id will be returned to use to associate this upload to record field or action parameters.
Declaration
Swift

func upload(data: Data, image: Bool = false, mimeType: String?, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<UploadResult, APIError>
upload(url:callbackQueue:progress:)
Upload file url data to server. An id will be returned to use to associate this upload to record field or action parameters.
Declaration
Swift

func upload(url: URL, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> Future<UploadResult, APIError>


                    
                    
                    recordPage(tableName:attributes:setID:recursive:configure:callbackQueue:progress:)

Get the records into simple structures. Only one page is loaded. You must get information from page to configure next request. @param tableName the table name @param attribute get only this attributes @param recursive receive all page until last one (default: false) @param configure closure to configure the request

Declaration

Swift

func recordPage(tableName: String,
                attributes: [String: Any] = [:],
                setID: QMobileAPI.EntitySetIdConvertible? = nil,
                recursive: Bool = false,
                configure: QMobileAPI.APIManager.ConfigureRecordsRequest? = nil,
                callbackQueue: DispatchQueue? = nil,
                progress: QMobileAPI.APIManager.ProgressHandler? = nil) -> Future<Page, APIError>


                    
                    
                    status(for:callbackQueue:progress:)

Undocumented

Declaration

Swift

static func status(for urls: [URL], callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil) -> AnyPublisher<[URL : Result<Status, APIError>], Never>


                    
                    
                    createRecordJSON(table:key:completionHandler:)

create new record

Declaration

Swift

public func createRecordJSON(
    table: Table,
    key: CustomStringConvertible,
    completionHandler: @escaping CompletionRecordJSONHandler) -> Cancellable


                    
                    
                    createOrUpdate(recordJSON:callbackQueue:completionHandler:)

Create or update a record

Declaration

Swift

public func createOrUpdate(
    recordJSON: RecordJSON,
    callbackQueue: DispatchQueue? = nil,
    completionHandler: CompletionRecordJSONHandler? = nil) -> Cancellable


                    
                    
                    CompletionRecordJSONsHandler

Alias for [RecordJSON]

Declaration

Swift

public typealias CompletionRecordJSONsHandler = ((Result<[RecordJSON], APIError>) -> Void)


                    
                    
                    createOrUpdate(recordJSONs:callbackQueue:completionHandler:)

Undocumented

Declaration

Swift

public func createOrUpdate(
    recordJSONs: [RecordJSON],
    callbackQueue: DispatchQueue? = nil,
    completionHandler: CompletionRecordJSONsHandler? = nil) -> Cancellable


                    
                    
                    createEntitySet(tableName:callbackQueue:configure:completionHandler:)

create a new entityset (could be done by using configuration of RecordsRequest of loadPage`)

Declaration

Swift

public func createEntitySet(
    tableName: String,
    callbackQueue: DispatchQueue? = nil,
    configure: ConfigureRecordsRequest? = nil,
    completionHandler: @escaping CompletionPageHandler) -> Cancellable


                    
                    
                    delete(recordJSON:completionHandler:)

Undocumented

Declaration

Swift

public func delete(recordJSON: RecordJSON, completionHandler: CompletionStatusHandler? = nil) -> Cancellable?


                    
                    
                    deleteRecord(tableName:key:callbackQueue:completionHandler:)

Undocumented

Declaration

Swift

public func deleteRecord(
    tableName: String,
    key: CustomStringConvertible,
    callbackQueue: DispatchQueue? = nil,
    completionHandler: CompletionStatusHandler? = nil) -> Cancellable


                    
                    
                    deleteRecords(tableName:configure:callbackQueue:completionHandler:)

delete records

Declaration

Swift

public func deleteRecords(
    tableName: String,
    configure: ConfigureRecordsRequest? = nil,
    callbackQueue: DispatchQueue? = nil,
    completionHandler: CompletionStatusHandler? = nil) -> Cancellable


                    
                    
                    delete(entitySet:callbackQueue:completionHandler:)

delete entity set

Declaration

Swift

public func delete(entitySet: EntitySet, callbackQueue: DispatchQueue? = nil, completionHandler: CompletionStatusHandler? = nil) -> Cancellable


                    
                    
                    deleteEntitySet(tableName:setID:callbackQueue:completionHandler:)

delete entity set

Declaration

Swift

public func deleteEntitySet(
    tableName: String,
    setID: String,
    callbackQueue: DispatchQueue? = nil,
    completionHandler: CompletionStatusHandler? = nil) -> Cancellable


                    
                    
                    release(entitySet:callbackQueue:completionHandler:)

release entity set

Declaration

Swift

public func release(entitySet: EntitySet, callbackQueue: DispatchQueue? = nil, completionHandler: CompletionStatusHandler? = nil) -> Cancellable


                    
                    
                    releaseEntitySet(tableName:setID:callbackQueue:completionHandler:)

release entity set

Declaration

Swift

public func releaseEntitySet(
    tableName: String,
    setID: String,
    callbackQueue: DispatchQueue? = nil,
    completionHandler: CompletionStatusHandler? = nil) -> Cancellable


                    
                    
                    CompletionStatusHandler

Undocumented

Declaration

Swift

public typealias CompletionStatusHandler = ((Result<Status, APIError>) -> Void)


                    
                    
                    status(callbackQueue:progress:completionHandler:)

Get server status

Declaration

Swift

public func status(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionStatusHandler) -> Cancellable


                    
                    
                    CompletionInfoHandler

Undocumented

Declaration

Swift

public typealias CompletionInfoHandler = ((Result<Info, APIError>) -> Void)


                    
                    
                    info(callbackQueue:progress:completionHandler:)

Get server info

Declaration

Swift

public func info(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionInfoHandler) -> Cancellable


                    
                    
                    CompletionSessionInfoHandler

Undocumented

Declaration

Swift

public typealias CompletionSessionInfoHandler = ((Result<[SessionInfo], APIError>) -> Void)


                    
                    
                    sessionInfo(callbackQueue:progress:completionHandler:)

Get server session info

Declaration

Swift

public func sessionInfo(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionSessionInfoHandler) -> Cancellable


                    
                    
                    CompletionProgressInfoHandler

Undocumented

Declaration

Swift

public typealias CompletionProgressInfoHandler = ((Result<[ProgressInfo], APIError>) -> Void)


                    
                    
                    progressInfo(callbackQueue:progress:completionHandler:)

Get server Progress Info

Declaration

Swift

public func progressInfo(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionProgressInfoHandler) -> Cancellable


                    
                    
                    CompletionCacheInfoHandler

Undocumented

Declaration

Swift

public typealias CompletionCacheInfoHandler = ((Result<[CacheInfo], APIError>) -> Void)


                    
                    
                    cacheInfo(callbackQueue:progress:completionHandler:)

Get server Cache Info

Declaration

Swift

public func cacheInfo(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionCacheInfoHandler) -> Cancellable


                    
                    
                    CompletionEntitySetInfoHandler

Undocumented

Declaration

Swift

public typealias CompletionEntitySetInfoHandler = ((Result<EntitySetInfo, APIError>) -> Void)


                    
                    
                    entitySetInfo(callbackQueue:progress:completionHandler:)

Get server Entity Set

Declaration

Swift

public func entitySetInfo(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionEntitySetInfoHandler) -> Cancellable


                    
                    
                    CompletionCatalogHandler

Undocumented

Declaration

Swift

public typealias CompletionCatalogHandler = ((Result<[Catalog], APIError>) -> Void)


                    
                    
                    catalog(callbackQueue:progress:completionHandler:)

Get the catalog, list description of URI for tables and records

Declaration

Swift

public func catalog(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionCatalogHandler) -> Cancellable


                    
                    
                    CompletionTablesHandler

Undocumented

Declaration

Swift

public typealias CompletionTablesHandler = ((Result<[Table], APIError>) -> Void)


                    
                    
                    tables(callbackQueue:progress:completionHandler:)

Get all tables

Declaration

Swift

public func tables(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionTablesHandler) -> Cancellable


                    
                    
                    CompletionTableHandler

Alias for table result.

Declaration

Swift

public typealias CompletionTableHandler = ((Result<Table, APIError>) -> Void)


                    
                    
                    table(name:callbackQueue:progress:completionHandler:)

Get one table by name @param table the wanted table name

Declaration

Swift

public func table(name: String, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionTableHandler) -> Cancellable


                    
                    
                    CompletionRecordJSONHandler

Alias for record json result.

Declaration

Swift

public typealias CompletionRecordJSONHandler = ((Result<RecordJSON, APIError>) -> Void)


                    
                    
                    recordJSON(table:key:attributes:callbackQueue:progress:completionHandler:)

Get one record into simple structures @param table the table @param key the primary key of wanted record @param attribute get only this attributes

Declaration

Swift

public func recordJSON(
    table: Table,
    key: CustomStringConvertible,
    attributes: [String: Any] = [:],
    callbackQueue: DispatchQueue? = nil,
    progress: ProgressHandler? = nil,
    completionHandler: @escaping CompletionRecordJSONHandler) -> Cancellable


                    
                    
                    CompletionPageHandler

Alias for Page result.

Declaration

Swift

public typealias CompletionPageHandler = ((Result<Page, APIError>) -> Void)


                    
                    
                    recordPage(table:attributes:setID:recursive:configure:callbackQueue:progress:completionHandler:)

Get the records into simple structures. You must get information from page to configure next request. @param table the table @param attribute get only this attributes @param recursive receive all page until last one (default: false) @param configure closure to configure the request

Declaration

Swift

public func recordPage(
    table: Table,
    attributes: [String: Any] = [:],
    setID: EntitySetIdConvertible? = nil,
    recursive: Bool = false,
    configure: ConfigureRecordsRequest? = nil,
    callbackQueue: DispatchQueue? = nil,
    progress: ProgressHandler? = nil,
    completionHandler: @escaping CompletionPageHandler) -> Cancellable

recordPage(tableName:attributes:setID:recursive:configure:callbackQueue:progress:completionHandler:)
Get the records into simple structures. Only one page is loaded. You must get information from page to configure next request. @param tableName the table name @param attribute get only this attributes @param recursive receive all page until last one (default: false) @param configure closure to configure the request
Declaration
Swift

public func recordPage( tableName: String, attributes: [String: Any] = [:], setID: EntitySetIdConvertible? = nil, recursive: Bool = false, configure: ConfigureRecordsRequest? = nil, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionPageHandler) -> Cancellable
deletedRecordPage(configure:callbackQueue:progress:completionHandler:)
Get the deleted records information into simple structures. Only one page is loaded. You must get information from page to configure next request. @param configure closure to configure the request
Declaration
Swift

public func deletedRecordPage( configure: ConfigureRecordsRequest? = nil, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionPageHandler) -> Cancellable


                    
                    
                    CompletionComputeHandler

Alias for compute result.

Declaration

Swift

public typealias CompletionComputeHandler = ((Result<Compute, APIError>) -> Void)


                    
                    
                    compute(table:attribute:operation:callbackQueue:progress:completionHandler:)

Compute an operation on specific attribute of one table. @param table the table @param attribute the attribute @param operation the operation to execute

Declaration

Swift

public func compute(table: String, attribute: String,
                    operation: ComputeOperation,
                    callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionComputeHandler) -> Cancellable


                    
                    
                    CompletionUploadResultHandler

Alias for UploadResultrequest result

Declaration

Swift

public typealias CompletionUploadResultHandler = ((Result<UploadResult, APIError>) -> Void)

Upload


                    
                    
                    upload(data:image:mimeType:callbackQueue:progress:completionHandler:)

Upload data to the server. Could be an image or a blob. An id will be returned to use to associate this upload to record field or action parameters.

Declaration

Swift

public func upload(data: Data, image: Bool = false, mimeType: String?, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionUploadResultHandler) -> Cancellable

upload(url:callbackQueue:progress:completionHandler:)
Upload file url data to server. An id will be returned to use to associate this upload to record field or action parameters.
Declaration
Swift

public func upload(url: URL, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionUploadResultHandler) -> Cancellable


                    
                    
                    CompletionUserInfoHandler

Alias for UserInfoResult

Declaration

Swift

public typealias CompletionUserInfoHandler = ((Result<UserInfoResult, APIError>) -> Void)


                    
                    
                    userInfo(_:deviceToken:callbackQueue:progress:completionHandler:)

POST userInfo on server

Declaration

Swift

public func userInfo(_ userInfo: [String: Any]? = nil,
                     deviceToken: String? = nil,
                     callbackQueue: DispatchQueue? = nil,
                     progress: ProgressHandler? = nil,
                     completionHandler: @escaping CompletionUserInfoHandler) -> Cancellable


                    
                    
                    sendDeviceToken(_:callbackQueue:progress:completionHandler:)

POST deviceToken on server

Declaration

Swift

public func sendDeviceToken(_ deviceToken: String? = nil,
                            callbackQueue: DispatchQueue? = nil,
                            progress: ProgressHandler? = nil,
                            completionHandler: @escaping CompletionUserInfoHandler) -> Cancellable


                    
                    
                    method(table:name:parameters:httpMethod:callbackQueue:progress:completionHandler:)

Call method on table.

Declaration

Swift

public func method(table: String,
                   name: String,
                   parameters: [String: Any] = [:],
                   httpMethod: Moya.Method = Moya.Method.get,
                   callbackQueue: DispatchQueue? = nil,
                   progress: ProgressHandler? = nil,
                   completionHandler: @escaping APIManager.Completion) -> Cancellable


                    
                    
                    method(table:method:parameters:httpMethod:callbackQueue:progress:completionHandler:)

Undocumented

Declaration

Swift

public func method(table: Table,
                   method: TableMethod,
                   parameters: [String: Any] = [:],
                   httpMethod: Moya.Method = Moya.Method.get,
                   callbackQueue: DispatchQueue? = nil,
                   progress: ProgressHandler? = nil,
                   completionHandler: @escaping APIManager.Completion) -> Cancellable

loginSuccess
Notify about log in success
Declaration
Swift

public static let loginSuccess: Notification.Name
loginPending
Notify about log in wait for validation
Declaration
Swift

public static let loginPending: Notification.Name
loginFailed
Notify about log in failure
Declaration
Swift

public static let loginFailed: Notification.Name


                    
                    
                    logout

Notify about log out

Declaration

Swift

public static let logout: Notification.Name

didChangeDefaultInstance
Notify default instance change.
Declaration
Swift

public static let didChangeDefaultInstance: Notification.Name


                    
                    
                    observe(_:queue:using:)

Observe APIManager on specific event usung closure.

Declaration

Swift

public static func observe(_ name: Notification.Name, queue: OperationQueue? = nil, using: @escaping (Notification) -> Void) -> NSObjectProtocol

unobserve(_:)
Unobserve APIManager by passing the handle returned by oberve function.
Declaration
Swift

public static func unobserve(_ observer: NSObjectProtocol)
unobserve(_:)
Unobserve APIManager by passing the handle returned by oberve function.
Declaration
Swift

public static func unobserve(_ observers: [NSObjectProtocol])


                    
                    
                    reachability(handler:)

Undocumented

Declaration

Swift

public func reachability(handler: @escaping NetworkReachabilityManager.Listener) -> Cancellable?


                    
                    
                    reachability(handler:)

Start reachability task.

Declaration

Swift

public static func reachability(handler: @escaping NetworkReachabilityManager.Listener) -> Cancellable?


                    
                    
                    retry(_:for:dueTo:completion:)

Declaration

Swift

public func retry(_ request: Request, for session: Session, dueTo error: Error, completion: @escaping (RetryResult) -> Void)

target(for:)
Find a target from an URL path. path could come from /rest api json data.
Declaration
Swift

public func target(for path: URLPath) -> TargetType?


                    
                    
                    target(for:)

Undocumented

Declaration

Swift

public func target(for deffered: Deferred) -> TargetType?


                    
                    
                    target(for:)

Undocumented

Declaration

Swift

public func target(for url: URL) -> TargetType?


                    
                    
                    CompletionWebTestInfoHandler

Undocumented

Declaration

Swift

public typealias CompletionWebTestInfoHandler = ((Result<WebTestInfo, APIError>) -> Void)


                    
                    
                    loadWebTestInfo(callbackQueue:progress:completionHandler:)

Get server status

Declaration

Swift

public func loadWebTestInfo(callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completionHandler: @escaping CompletionWebTestInfoHandler) -> Cancellable

configure(request:)
Configure a custom URL request with all needed headers.
Declaration
Swift

open func configure(request: URLRequest) -> URLRequest

request methods


                    
                    
                    request(_:callbackQueue:progress:completion:)

Make a request.

Declaration

Swift

public func request<T>(_ target: T, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completion: @escaping APIManager.Completion) -> Cancellable where T : TargetType

Parameters

`target`	the target.
`callbackQueue`	an optional queue for callback
`progress`	callback to receive progression info
`completion`	completion callback to receive raw moya response.

Return Value

a cancellable object for this request.


                    
                    
                    request(_:callbackQueue:progress:completion:)

Make a request.

Declaration

Swift

public func request<T>(_ target: T, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completion: @escaping (Result<T.ResultType, APIError>) -> Void) -> Cancellable where T : DecodableTargetType

Parameters

`target`	the target.
`callbackQueue`	an optional queue for callback
`progress`	callback to receive progression info
`completion`	completion callback to receive data as decoded object.

Return Value

a cancellable object for this request.


                    
                    
                    request(_:callbackQueue:progress:completion:)

Make a request.

Declaration

Swift

public func request<T>(_ target: T, callbackQueue: DispatchQueue? = nil, progress: ProgressHandler? = nil, completion: @escaping (Result<[T.ResultType], APIError>) -> Void) -> Cancellable where T : DecodableTargetType

Parameters

`target`	the target.
`callbackQueue`	an optional queue for callback
`progress`	callback to receive progression info
`completion`	completion callback to receive data as a collection of decoded object.

Return Value

a cancellable object for this request.


                    
                    
                    records(table:attributes:setID:recursive:configure:initializer:queue:progress:completionHandler:)

Get records using specific object builder. This avoid passing by an intermediate object RecordObject which contains only JSON data.

Declaration

Swift

public func records<B: ImportableBuilder>(
    table: Table,
    attributes: [String: Any] = [:],
    setID: String? = nil,
    recursive: Bool = true,
    configure: ((RecordsRequest) -> Void)? = nil,
    initializer: B,
    queue: DispatchQueue? = nil,
    progress: ProgressHandler? = nil,
    completionHandler: @escaping ((Result<([B.Importable], PageInfo), APIError>) -> Void)) -> Cancellable


                    
                    
                    loadRecord(table:key:attributes:initializer:queue:progress:completionHandler:)

Undocumented

Declaration

Swift

public func loadRecord<B: ImportableBuilder>(
    table: Table,
    key: CustomStringConvertible,
    attributes: [String: Any] = [:],
    initializer: B,
    queue: DispatchQueue? = nil,
    progress: ProgressHandler? = nil,
    completionHandler: @escaping ((Result<B.Importable, APIError>) -> Void)) -> Cancellable