Structures

The following structures are available globally.

  • API

    The REST API for communicating with the Parse Server.

    See more

    Declaration

    Swift

    public struct API
  • Provides utility functions for working with Apple User Authentication and ParseUser‘s. Be sure your Parse Server is configured for sign in with Apple. For information on acquiring Apple sign-in credentials to use with ParseApple, refer to Apple’s Documentation.

    See more

    Declaration

    Swift

    public struct ParseApple<AuthenticatedUser> : ParseAuthentication where AuthenticatedUser : ParseUser
  • Provides utility functions for working with LDAP User Authentication and ParseUser‘s. Be sure your Parse Server is configured for sign in with LDAP.

    See more

    Declaration

    Swift

    public struct ParseLDAP<AuthenticatedUser> : ParseAuthentication where AuthenticatedUser : ParseUser
  • Provides utility functions for working with Anonymously logged-in users.

    Anonymous users have some unique characteristics:

    • Anonymous users don’t need a user name or password.
    • Once logged out, an anonymous user cannot be recovered.
    • When the current user is anonymous, the following methods can be used to switch to a different user or convert the anonymous user into a regular one:
    • signup converts an anonymous user to a standard user with the given username and password. Data associated with the anonymous user is retained.
    • login switches users without converting the anonymous user. Data associated with the anonymous user will be lost.
    • Service login (e.g. Apple, Facebook, Twitter) will attempt to convert the anonymous user into a standard user by linking it to the service. If a user already exists that is linked to the service, it will instead switch to the existing user.
    • Service linking (e.g. Apple, Facebook, Twitter) will convert the anonymous user into a standard user by linking it to the service.
    See more

    Declaration

    Swift

    public struct ParseAnonymous<AuthenticatedUser> : ParseAuthentication where AuthenticatedUser : ParseUser
  • A type-erased Codable value.

    The AnyCodable type forwards encoding and decoding responsibilities to an underlying value, hiding its specific underlying type.

    You can encode or decode mixed-type values in dictionaries and other collections that require Encodable or Decodable conformance by declaring their contained type to be AnyCodable.

    See also

    AnyEncodable

    See also

    AnyDecodable

    Source: https://github.com/Flight-School/AnyCodable

    See more

    Declaration

    Swift

    public struct AnyCodable : Codable
    extension AnyCodable: Equatable
    extension AnyCodable: CustomStringConvertible
    extension AnyCodable: CustomDebugStringConvertible
    extension AnyCodable: ExpressibleByNilLiteral
    extension AnyCodable: ExpressibleByBooleanLiteral
    extension AnyCodable: ExpressibleByIntegerLiteral
    extension AnyCodable: ExpressibleByFloatLiteral
    extension AnyCodable: ExpressibleByStringLiteral
    extension AnyCodable: ExpressibleByArrayLiteral
    extension AnyCodable: ExpressibleByDictionaryLiteral
  • A type-erased Decodable value.

    The AnyDecodable type forwards decoding responsibilities to an underlying value, hiding its specific underlying type.

    You can decode mixed-type values in dictionaries and other collections that require Decodable conformance by declaring their contained type to be AnyDecodable:

    let json = """
    {
        "boolean": true,
        "integer": 1,
        "double": 3.14159265358979323846,
        "string": "string",
        "array": [1, 2, 3],
        "nested": {
            "a": "alpha",
            "b": "bravo",
            "c": "charlie"
        }
    }
    """.data(using: .utf8)!
    
    let decoder = JSONDecoder()
    let dictionary = try! decoder.decode([String: AnyCodable].self, from: json)
    
    See more

    Declaration

    Swift

    public struct AnyDecodable : Decodable
    extension AnyDecodable: Equatable
    extension AnyDecodable: CustomStringConvertible
    extension AnyDecodable: CustomDebugStringConvertible
  • A type-erased Encodable value.

    The AnyEncodable type forwards encoding responsibilities to an underlying value, hiding its specific underlying type.

    You can encode mixed-type values in dictionaries and other collections that require Encodable conformance by declaring their contained type to be AnyEncodable:

    let dictionary: [String: AnyEncodable] = [
        "boolean": true,
        "integer": 1,
        "double": 3.14159265358979323846,
        "string": "string",
        "array": [1, 2, 3],
        "nested": [
            "a": "alpha",
            "b": "bravo",
            "c": "charlie"
        ]
    ]
    
    let encoder = JSONEncoder()
    let json = try! encoder.encode(dictionary)
    

    Source: https://github.com/Flight-School/AnyCodable

    See more

    Declaration

    Swift

    public struct AnyEncodable : Encodable
    extension AnyEncodable: Equatable
    extension AnyEncodable: CustomStringConvertible
    extension AnyEncodable: CustomDebugStringConvertible
    extension AnyEncodable: ExpressibleByNilLiteral
    extension AnyEncodable: ExpressibleByBooleanLiteral
    extension AnyEncodable: ExpressibleByIntegerLiteral
    extension AnyEncodable: ExpressibleByFloatLiteral
    extension AnyEncodable: ExpressibleByStringLiteral
    extension AnyEncodable: ExpressibleByArrayLiteral
    extension AnyEncodable: ExpressibleByDictionaryLiteral

Query

  • The Query class defines a query that is used to query for ParseObjects.

    See more

    Declaration

    Swift

    public struct Query<T> : Encodable, Equatable where T : ParseObject
    extension Query: Queryable
  • A ParseOperation represents a modification to a value in a ParseObject. For example, setting, deleting, or incrementing a value are all ParseOperation‘s. ParseOperation themselves can be considered to be immutable.

    In most cases, you should not call this class directly as a ParseOperation can be indirectly created from any ParseObject by using its operation property.

    See more

    Declaration

    Swift

    public struct ParseOperation<T> : Savable where T : ParseObject
  • ParseSwift contains static methods to handle global configuration for the Parse framework.

    See more

    Declaration

    Swift

    public struct ParseSwift
  • ParseACL is used to control which users can access or modify a particular ParseObject. Each ParseObject has its own ACL. You can grant read and write permissions separately to specific users, to groups of users that belong to roles, or you can grant permissions to “the public” so that, for example, any user could read a particular object but only a particular set of users could write to that object.

    See more

    Declaration

    Swift

    public struct ParseACL : ParseType, Decodable, Equatable, Hashable
    extension ParseACL: CustomDebugStringConvertible
  • A ParseFile object representes a file of binary data stored on the Parse server. This can be a image, video, or anything else that an application needs to reference in a non-relational way.

    See more

    Declaration

    Swift

    public struct ParseFile : Fileable, Savable, Fetchable, Deletable
  • ParseGeoPoint is used to embed a latitude / longitude point as the value for a key in a ParseObject. It could be used to perform queries in a geospatial manner using ParseQuery.-whereKey:nearGeoPoint:. Currently, instances of ParseObject may only have one key associated with a ParseGeoPoint type.

    See more

    Declaration

    Swift

    public struct ParseGeoPoint : Codable, Hashable
    extension ParseGeoPoint: CustomDebugStringConvertible
  • The ParseRelation class that is used to access all of the children of a many-to-many relationship. Each instance of ParseRelation is associated with a particular parent object and key.

    See more

    Declaration

    Swift

    public struct ParseRelation<T> : Codable where T : ParseObject
  • All available query constraints.

    See more

    Declaration

    Swift

    public struct QueryConstraint : Encodable, Equatable