LCFile

public class LCFile : LCObject

LeanCloud File Type

Show on GitHub


                    
                    
                    objectClassName()

Declaration

Swift

public final override class func objectClassName() -> String

Show on GitHub

url
The file URL.
Declaration
Swift

@objc public dynamic var url: LCString?
Show on GitHub
key
The file key.

It’s the resource key of third-party file hosting provider. It may be nil for some providers.
Declaration
Swift

@objc public dynamic var key: LCString?
Show on GitHub
name
The file name.
Declaration
Swift

@objc public dynamic var name: LCString?
Show on GitHub
metaData
The file meta data.
Declaration
Swift

@objc public dynamic var metaData: LCDictionary?
Show on GitHub
provider
The file hosting provider.
Declaration
Swift

@objc public dynamic var provider: LCString?
Show on GitHub
bucket
The file bucket.
Declaration
Swift

@objc public dynamic var bucket: LCString?
Show on GitHub
mimeType
The MIME type of file.

For uploading, you can use this property to explictly set MIME type of file content.

It’s an alias of property ‘mime_type’.
Declaration
Swift

public var mimeType: LCString? { get set }
Show on GitHub
Payload
File Payload.
See more
Declaration
Swift

public enum Payload
Show on GitHub


                    
                    
                    payload

@see Payload.

Declaration

Swift

public private(set) var payload: Payload? { get }

Show on GitHub

Init

init()
Create a file using default application.
Declaration
Swift

public required init()
Show on GitHub


                    
                    
                    init(application:)

Create a file using a application.

Declaration

Swift

public required init(application: LCApplication)

Parameters


                                application

The application which this file belong to.

Show on GitHub


                    
                    
                    init(application:url:)

Create a file with a URL.

Declaration

Swift

public convenience init(
    application: LCApplication = .default,
    url: LCStringConvertible)

Parameters

`application`	The application which this file belong to. default is default application.
`url`	The location of a resource on a remote server.

Show on GitHub


                    
                    
                    init(application:payload:)

Create a file from payload.

Declaration

Swift

public convenience init(
    application: LCApplication = .default,
    payload: Payload)

Parameters

`application`	The application which this file belong to. default is default application.
`payload`	@see `Payload`.

Show on GitHub

Save

keepFileName
If set it to true, then will use “/(LCFile.name)” as URL suffix when creating file from payload. default is false.
Declaration
Swift

public var keepFileName: Bool
Show on GitHub
Options
Save Options
See more
Declaration
Swift

public struct Options : OptionSet
Show on GitHub


                    
                    
                    save(options:)

Save file synchronously.

Declaration

Swift

public func save(options: LCFile.Options = []) -> LCBooleanResult

Parameters


                                options

@see LCFile.Options, default is none.

Show on GitHub


                    
                    
                    save(options:progressQueue:progress:completionQueue:completion:)

Save file asynchronously.

Declaration

Swift

@discardableResult
public func save(
    options: LCFile.Options = [],
    progressQueue: DispatchQueue = .main,
    progress: ((Double) -> Void)? = nil,
    completionQueue: DispatchQueue = .main,
    completion: @escaping (LCBooleanResult) -> Void)
    -> LCRequest

Parameters

`options`	@see `LCFile.Options`, default is none.
`progressQueue`	The queue where the progress be called. default is main.
`progress`	The progress of saving.
`completionQueue`	The queue where the completion be called. default is main.
`completion`	The callback of result.

Show on GitHub

Qiniu

Thumbnail
Parameters of Thumbnail.
See more
Declaration
Swift

public enum Thumbnail
Show on GitHub


                    
                    
                    thumbnailURL(_:)

Get the Thumbnail URL. @note: only work on Qiniu URL.

Declaration

Swift

public func thumbnailURL(_ thumbnail: Thumbnail) -> URL?

Parameters


                                thumbnail

@see Thumbnail.

Show on GitHub