Poly Class Reference

properties

apiKey
Poly API Key, https://developers.google.com/poly/develop/api
Declaration
Swift

public var apiKey: String?
authToken
Auth token for ‘me’ requests, https://developers.google.com/identity/protocols/OAuth2
Declaration
Swift

public var authToken: String? { get set }
networkReachable
Network reachability status of poly.googleapis.com
Declaration
Swift

public var networkReachable: Bool { get }
backgroundCompletionHandler
CompletionHandler for managing background transfers
Declaration
Swift

public var backgroundCompletionHandler: (() -> Void)? { get set }

singleton

shared
Poly singleton (if desired)
Declaration
Swift

public static let shared: Poly

object lifecycle

init()
Initializer for Poly
Declaration
Swift

public init()

setup

reset()
Reset client configuration
Declaration
Swift

public func reset()
cancelAllDataTasks()
Cancel all data transfers
Declaration
Swift

public func cancelAllDataTasks()

UIApplication integration


                    
                    
                    application(_:didFinishLaunchingWithOptions:)

UIApplication integration support for background transfers

Declaration

Swift

public func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]?) -> Bool

request completion types


                    
                    
                    ProgressHandler

Undocumented

Declaration

Swift

public typealias ProgressHandler = (_ progress: Float) -> Void


                    
                    
                    CompletionHandler

Undocumented

Declaration

Swift

public typealias CompletionHandler = (_ data: Data?, _ error: Error?) -> Void


                    
                    
                    AssetsCompletionHandler

Undocumented

Declaration

Swift

public typealias AssetsCompletionHandler = (_ assets: [PolyAssetModel]?, _ totalAssetCount: Int, _ nextPage: Int, _ error: Error?) -> Void


                    
                    
                    get(assetWithIdentifier:completionHandler:)

Returns detailed information about an asset given its name.

Declaration

Swift

public func get(assetWithIdentifier assetIdentifier: String,
                completionHandler: AssetsCompletionHandler? = nil)


                    
                    
                    list(assetsWithKeywords:curated:category:complexity:format:pageToken:completionHandler:)

Lists all public, remixable assets.

Declaration

Swift

public func list(assetsWithKeywords keywords: [String],
                 curated: Bool = false,
                 category: String? = nil,
                 complexity: PolyComplexity = .unspecified,
                 format: PolyFormat = .obj,
                 pageToken: String? = nil,
                 completionHandler: AssetsCompletionHandler? = nil)


                    
                    
                    get(assetWithIdentifier:completionHandler:)

Returns detailed information about an asset given its name, in raw data.

Declaration

Swift

public func get(assetWithIdentifier assetIdentifier: String,
                completionHandler: CompletionHandler? = nil)


                    
                    
                    list(assetsWithKeywords:curated:category:complexity:format:pageToken:completionHandler:)

Lists all public, remixable assets, in raw data.

Declaration

Swift

public func list(assetsWithKeywords keywords: [String],
                 curated: Bool = false,
                 category: String? = nil,
                 complexity: PolyComplexity = .unspecified,
                 format: PolyFormat = .obj,
                 pageToken: String? = nil,
                 completionHandler: CompletionHandler? = nil)

completion types


                    
                    
                    DownloadCompletionHandler

Undocumented

Declaration

Swift

public typealias DownloadCompletionHandler = (_ rootFile: URL?, _ resourceFiles: [URL]?, _ error: Error?) -> Void


                    
                    
                    download(assetWithIdentifier:cachePolicy:progressHandler:completionHandler:)

Downloads the specified asset by identifier.

Declaration

Swift

public func download(assetWithIdentifier assetIdentifier: String,
                     cachePolicy: PolyRequest.CachePolicy = .returnCacheDataElseFetch,
                     progressHandler: ProgressHandler? = nil,
                     completionHandler: DownloadCompletionHandler? = nil)

Parameters

`assetIdentifier`	Asset identifier
`cachePolicy`	Cache policy
`progressHandler`	Handler for progress updates
`completionHandler`	Handler for task completion


                    
                    
                    download(asset:cachePolicy:progressHandler:completionHandler:)

Downloads the specified asset by model.

Declaration

Swift

public func download(asset: PolyAssetModel,
                     cachePolicy: PolyRequest.CachePolicy = .returnCacheDataElseFetch,
                     progressHandler: ProgressHandler? = nil,
                     completionHandler: DownloadCompletionHandler? = nil)

Parameters

`asset`	Poly asset to download
`cachePolicy`	Cache policy
`progressHandler`	Handler for progress updates
`completionHandler`	Handler for task completion