http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html deleted file mode 100644 index 3e5118a..0000000 --- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAppAuth.html +++ /dev/null @@ -1,402 +0,0 @@ - - - - UsergridAppAuth Class Reference - - - - - - - - - - -
-
-

UsergridSDK Docs (100% documented)

-
-
-
- -
-
- -
-
-
-

UsergridAppAuth

-
-
-
public class UsergridAppAuth : UsergridAuth
- -
-
-

The UsergridAuth subclass used for application level authorization.

- -
-
-
- -
    -
  • -
    - - - - clientId - -
    -
    -
    -
    -
    -
    -

    The client identifier associated with the application.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public let clientId: String
    - -
    -
    -
    -
    -
  • -
-
-
- -
    -
  • - -
    -
    -
    -
    -
    -

    Designated initializer for UsergridAppAuth objects.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public init(clientId:String,clientSecret:String)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - clientId - - -
    -

    The client identifier associated with the application.

    - -
    -
    - - clientSecret - - -
    -

    The client secret associated with the application.

    - -
    -
    -
    -
    -

    Return Value

    -

    A new instance of UsergridAppAuth.

    - -
    -
    -
    -
  • -
-
-
- -
    -
  • -
    - - - - init(coder:) - -
    -
    -
    -
    -
    -
    -

    NSCoding protocol initializer.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    required public init?(coder aDecoder: NSCoder)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - aDecoder - - -
    -

    The decoder.

    - -
    -
    -
    -
    -

    Return Value

    -

    A decoded UsergridUser object.

    - -
    -
    -
    -
  • -
  • -
    - - - - encodeWithCoder(_:) - -
    -
    -
    -
    -
    -
    -

    NSCoding protocol encoder.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    override public func encodeWithCoder(aCoder: NSCoder)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - aCoder - - -
    -

    The encoder.

    - -
    -
    -
    -
    -
    -
  • -
-
-
-
- -
-
- - - http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html deleted file mode 100644 index b473cd1..0000000 --- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAsset.html +++ /dev/null @@ -1,694 +0,0 @@ - - - - UsergridAsset Class Reference - - - - - - - - - - -
-
-

UsergridSDK Docs (100% documented)

-
-
-
- -
-
- -
-
-
-

UsergridAsset

-
-
-
public class UsergridAsset: NSObject, NSCoding
- -
-
-

As Usergrid supports storing binary assets, the SDKs are designed to make uploading assets easier and more robust. Attaching, uploading, and downloading assets is handled by the UsergridEntity class.

- -

Unless defined, whenever possible, the content-type will be inferred from the data provided, and the attached file (if not already a byte-array representation) will be binary-encoded.

- -
-
-
- -
    -
  • -
    - - - - filename - -
    -
    -
    -
    -
    -
    -

    The filename to be used in the multipart/form-data request.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public let filename: String
    - -
    -
    -
    -
    -
  • -
  • -
    - - - - data - -
    -
    -
    -
    -
    -
    -

    Binary representation of the asset’s data.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public let data: NSData
    - -
    -
    -
    -
    -
  • -
  • -
    - - - - originalLocation - -
    -
    -
    -
    -
    -
    -

    A representation of the folder location the asset was loaded from, if it was provided in the initialization.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public let originalLocation: String?
    - -
    -
    -
    -
    -
  • -
  • -
    - - - - contentType - -
    -
    -
    -
    -
    -
    -

    The Content-type of the asset to be used when defining content-type inside the multipart/form-data request.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public var contentType: String
    - -
    -
    -
    -
    -
  • -
  • -
    - - - - contentLength - -
    -
    -
    -
    -
    -
    -

    The content length of the assets data.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public var contentLength: Int { return self.data.length }
    - -
    -
    -
    -
    -
  • -
-
-
- -
    -
  • - -
    -
    -
    -
    -
    -

    Designated initializer for UsergridAsset objects.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public init(filename:String? = UsergridAsset.DEFAULT_FILE_NAME, data:NSData, originalLocation:String? = nil, contentType:String)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - -
    - - fileName - - -
    -

    The file name associated with the file data.

    - -
    -
    - - data - - -
    -

    The data of the file.

    - -
    -
    - - originalLocation - - -
    -

    An optional original location of the file.

    - -
    -
    - - contentType - - -
    -

    The content type of the file.

    - -
    -
    -
    -
    -

    Return Value

    -

    A new instance of UsergridAsset.

    - -
    -
    -
    -
  • -
  • - -
    -
    -
    -
    -
    -

    Convenience initializer for UsergridAsset objects dealing with image data.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public convenience init?(fileName:String? = UsergridAsset.DEFAULT_FILE_NAME, image:UIImage, imageContentType:UsergridImageContentType = .Png)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - fileName - - -
    -

    The file name associated with the file data.

    - -
    -
    - - image - - -
    -

    The UIImage object to upload.

    - -
    -
    - - imageContentType - - -
    -

    The content type of the UIImage

    - -
    -
    -
    -
    -

    Return Value

    -

    A new instance of UsergridAsset if the data can be gathered from the passed in UIImage, otherwise nil.

    - -
    -
    -
    -
  • -
  • - -
    -
    -
    -
    -
    -

    Convenience initializer for UsergridAsset objects dealing directly with files on disk.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public convenience init?(fileName:String? = UsergridAsset.DEFAULT_FILE_NAME, fileURL:NSURL, contentType:String? = nil)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - -
    - - fileName - - -
    -

    The file name associated with the file data.

    - -
    -
    - - fileURL - - -
    -

    The NSURL object associated with the file.

    - -
    -
    - - contentType - - -
    -

    The content type of the UIImage. If not specified it will try to figure out the type and if it can’t initialization will fail.

    - -
    -
    -
    -
    -

    Return Value

    -

    A new instance of UsergridAsset if the data can be gathered from the passed in NSURL, otherwise nil.

    - -
    -
    -
    -
  • -
-
-
- -
    -
  • -
    - - - - init(coder:) - -
    -
    -
    -
    -
    -
    -

    NSCoding protocol initializer.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    required public init?(coder aDecoder: NSCoder)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - aDecoder - - -
    -

    The decoder.

    - -
    -
    -
    -
    -

    Return Value

    -

    A decoded UsergridUser object.

    - -
    -
    -
    -
  • -
  • -
    - - - - encodeWithCoder(_:) - -
    -
    -
    -
    -
    -
    -

    NSCoding protocol encoder.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public func encodeWithCoder(aCoder: NSCoder)
    - -
    -
    -
    -

    Parameters

    - - - - - - - -
    - - aCoder - - -
    -

    The encoder.

    - -
    -
    -
    -
    -
    -
  • -
-
-
-
- -
-
- - - http://git-wip-us.apache.org/repos/asf/usergrid/blob/ae39eca6/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html ---------------------------------------------------------------------- diff --git a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html b/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html deleted file mode 100644 index 393f872..0000000 --- a/sdks/swift/docs/docsets/UsergridSDK.docset/Contents/Resources/Documents/Classes/UsergridAssetUploadRequest.html +++ /dev/null @@ -1,348 +0,0 @@ - - - - UsergridAssetUploadRequest Class Reference - - - - - - - - - - -
-
-

UsergridSDK Docs (100% documented)

-
-
-
- -
-
- -
-
-
-

UsergridAssetUploadRequest

-
-
-
public class UsergridAssetUploadRequest: UsergridRequest
- -
-
-

The UsergridRequest sub class which is used for uploading assets.

- -
-
-
- -
    -
  • -
    - - - - asset - -
    -
    -
    -
    -
    -
    -

    The asset to use for uploading.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public let asset: UsergridAsset
    - -
    -
    -
    -
    -
  • -
  • -
    - - - - multiPartHTTPBody - -
    -
    -
    -
    -
    -
    -

    A constructed multipart http body for requests to upload.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public var multiPartHTTPBody: NSData
    - -
    -
    -
    -
    -
  • -
-
-
- -
    -
  • - -
    -
    -
    -
    -
    -

    The designated initializer for UsergridAssetUploadRequest objects.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public init(baseUrl:String,
    -                paths:[String]? = nil,
    -                auth:UsergridAuth? = nil,
    -                asset:UsergridAsset)
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - -
    - - baseUrl - - -
    -

    The base URL.

    - -
    -
    - - paths - - -
    -

    The optional paths to append to the base URL.

    - -
    -
    - - auth - - -
    -

    The optional UsergridAuth that will be used in the Authorization header.

    - -
    -
    - - asset - - -
    -

    The asset to upload.

    - -
    -
    -
    -
    -

    Return Value

    -

    A new instance of UsergridRequest.

    - -
    -
    -
    -
  • -
-
-
-
- -
-
- - -