Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 85E0F200B9C for ; Fri, 2 Sep 2016 01:51:40 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id BDAB9160ACE; Thu, 1 Sep 2016 23:51:26 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id C7450160AD0 for ; Fri, 2 Sep 2016 01:51:24 +0200 (CEST) Received: (qmail 10178 invoked by uid 500); 1 Sep 2016 23:51:23 -0000 Mailing-List: contact commits-help@usergrid.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@usergrid.apache.org Delivered-To: mailing list commits@usergrid.apache.org Received: (qmail 8972 invoked by uid 99); 1 Sep 2016 23:51:23 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 01 Sep 2016 23:51:23 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 22A0DE08BA; Thu, 1 Sep 2016 23:51:23 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: mrusso@apache.org To: commits@usergrid.apache.org Date: Thu, 01 Sep 2016 23:52:02 -0000 Message-Id: <7ee6cbb6f31f4747bf0eb69a060640cc@git.apache.org> In-Reply-To: <1f5f93f069734adb9229615f865fb669@git.apache.org> References: <1f5f93f069734adb9229615f865fb669@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [41/51] [partial] usergrid-swift git commit: Initial commit of Usergrid Swift SDK. archived-at: Thu, 01 Sep 2016 23:51:41 -0000 http://git-wip-us.apache.org/repos/asf/usergrid-swift/blob/8283a6dd/docs/Classes/UsergridAppAuth.html ---------------------------------------------------------------------- diff --git a/docs/Classes/UsergridAppAuth.html b/docs/Classes/UsergridAppAuth.html new file mode 100644 index 0000000..70c940e --- /dev/null +++ b/docs/Classes/UsergridAppAuth.html @@ -0,0 +1,410 @@ + + + + UsergridAppAuth Class Reference + + + + + + + + + + +
+
+

Docs (100% documented)

+
+
+
+ +
+
+ +
+
+
+

UsergridAppAuth

+
+
+ 
public class UsergridAppAuth : UsergridAuth
+ +
+
+

The UsergridAuth subclass used for application level authorization.

+ +
+
+
+
+ + + +

Instance Properties

+ +
+
    +
  • +
    + + + + clientId + +
    +
    +
    +
    +
    +
    +

    The client identifier associated with the application.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let clientId: String
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + + +

Initialization

+ +
+
    +
  • + +
    +
    +
    +
    +
    +

    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.

    + +
    +
    +
    +
    • +
+
+
+
+ + + +

NSCoding

+ +
+
    +
  • +
    + + + + init(coder:) + +
    +
    +
    +
    +
    +
    +

    NSCoding protocol initializer.

    + +
    +
    +

    Declaration

    +
    +

    Swift

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

    Parameters

    + + + + + + + +
    + + aDecoder + + +
    +

    The decoder.

    + +
    +
    +
    +
    +

    Return Value

    +

    A decoded UsergridAppAuth 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-swift/blob/8283a6dd/docs/Classes/UsergridAsset.html ---------------------------------------------------------------------- diff --git a/docs/Classes/UsergridAsset.html b/docs/Classes/UsergridAsset.html new file mode 100644 index 0000000..568d727 --- /dev/null +++ b/docs/Classes/UsergridAsset.html @@ -0,0 +1,702 @@ + + + + UsergridAsset Class Reference + + + + + + + + + + +
+
+

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.

+ +
+
+
+
+ + + +

Instance Properties

+ +
+
    +
  • +
    + + + + 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 }
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + + +

Initialization

+ +
+
    +
  • + +
    +
    +
    +
    +
    +

    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.

    + +
    +
    +
    +
    • +
+
+
+
+ + + +

NSCoding

+ +
+
    +
  • +
    + + + + 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-swift/blob/8283a6dd/docs/Classes/UsergridAssetUploadRequest.html ---------------------------------------------------------------------- diff --git a/docs/Classes/UsergridAssetUploadRequest.html b/docs/Classes/UsergridAssetUploadRequest.html new file mode 100644 index 0000000..f7a0b00 --- /dev/null +++ b/docs/Classes/UsergridAssetUploadRequest.html @@ -0,0 +1,356 @@ + + + + UsergridAssetUploadRequest Class Reference + + + + + + + + + + +
+
+

Docs (100% documented)

+
+
+
+ +
+
+ +
+
+
+

UsergridAssetUploadRequest

+
+
+ 
public class UsergridAssetUploadRequest: UsergridRequest
+ +
+
+

The UsergridRequest sub class which is used for uploading assets.

+ +
+
+
+
+ + + +

Instance Properties

+ +
+
    +
  • +
    + + + + 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
    + +
    +
    +
    +
    +
    • +
+
+
+
+ + + +

Initialization

+ +
+
    +
  • + +
    +
    +
    +
    +
    +

    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.

    + +
    +
    +
    +
    • +
+
+
+
+ +
+
+ + +