BarracksClient

open class BarracksClient

The main entry point for using Barracks’ SDK. This class provides methods to help you getting information about the available updates for a specific configuration.

networkSessionManager
Network Session Manager
Declaration
Swift

public var networkSessionManager:SessionManager
Show on GitHub


                    
                    
                    init(_:baseUrl:ignoreSSL:)

Create a client using the parameters provided by the Barracks platform.

Declaration

Swift

public init(_ apiKey:String, baseUrl:String = "https://app.barracks.io/api/device/update/check", ignoreSSL:Bool = false)

Parameters

`apiKey`	Your account’s API key
`baseUrl`	The base URL for Barracks, if you have set one up
`ignoreSSL`	Flag to ignore SSL certificate check

Show on GitHub


                    
                    
                    checkUpdate(_:callback:)

This method is used to check wether an update is available on the Barracks service.

Declaration

Swift

public func checkUpdate(_ request:UpdateCheckRequest, callback:UpdateCheckCallback)

Parameters

`request`	The `UpdateCheckRequest` used to perform the check
`callback`	The `UpdateCheckCallback` called during the process

Show on GitHub


                    
                    
                    downloadPackage(_:callback:destination:)

This method is used to download an update package from the Barracks service.

Declaration

Swift

public func downloadPackage(_ response:UpdateCheckResponse, callback:PackageDownloadCallback, destination:String? = nil)

Parameters

`response`	The `UpdateCheckResponse` retrieved using `BarracksClient.checkUpdate(_:callback:)`
`callback`	The `PackageDownloadCallback` which will be called during the process
`destination`	The optional destination for the update package on the filesystem

Show on GitHub