ParseLDAP Structure Reference


                    
                    
                    __type

Declaration

Swift

public static var __type: String { get }

init()
Declaration
Swift

public init()

Async/Await


                    
                    
                    login(id:password:options:)

Asynchronous

Login a ParseUser asynchronously using LDAP authentication.

Throws

An error of type ParseError.

Declaration

Swift

func login(id: String,
           password: String,
           options: API.Options = []) async throws -> AuthenticatedUser

Parameters

`id`	The id of the `user`.
`password`	The password of the user.
`options`	A set of header options sent to the server. Defaults to an empty set.

Return Value

An instance of the logged in ParseUser.


                    
                    
                    login(authData:options:)

Asynchronous

Login a ParseUser asynchronously using LDAP authentication.

Throws

An error of type ParseError.

Declaration

Swift

func login(authData: [String: String],
           options: API.Options = []) async throws -> AuthenticatedUser

Parameters

`authData`	Dictionary containing key/values.
`options`	A set of header options sent to the server. Defaults to an empty set.

Return Value

An instance of the logged in ParseUser.


                    
                    
                    link(id:password:options:)

Asynchronous

Link the current ParseUser asynchronously using LDAP authentication.

Throws

An error of type ParseError.

Declaration

Swift

func link(id: String,
          password: String,
          options: API.Options = []) async throws -> AuthenticatedUser

Parameters

`id`	The id of the `user`.
`password`	The password of the user.
`options`	A set of header options sent to the server. Defaults to an empty set.

Return Value

An instance of the logged in ParseUser.


                    
                    
                    link(authData:options:)

Asynchronous

Link the current ParseUser asynchronously using LDAP authentication.

Throws

An error of type ParseError.

Declaration

Swift

func link(authData: [String: String],
          options: API.Options = []) async throws -> AuthenticatedUser

Parameters

`authData`	Dictionary containing key/values.
`options`	A set of header options sent to the server. Defaults to an empty set.

Return Value

An instance of the logged in ParseUser.

Combine


                    
                    
                    loginPublisher(id:password:options:)

Login a ParseUser asynchronously using LDAP authentication. Publishes when complete.

Declaration

Swift

func loginPublisher(id: String,
                    password: String,
                    options: API.Options = []) -> Future<AuthenticatedUser, ParseError>

Parameters

`id`	The id of the `user`.
`password`	The password of the user.
`options`	A set of header options sent to the server. Defaults to an empty set.

Return Value

A publisher that eventually produces a single value and then finishes or fails.


                    
                    
                    loginPublisher(authData:options:)

Login a ParseUser asynchronously using LDAP authentication. Publishes when complete.

Declaration

Swift

func loginPublisher(authData: [String: String],
                    options: API.Options = []) -> Future<AuthenticatedUser, ParseError>

Parameters

`authData`	Dictionary containing key/values.
`options`	A set of header options sent to the server. Defaults to an empty set.

Return Value

A publisher that eventually produces a single value and then finishes or fails.


                    
                    
                    linkPublisher(id:password:options:)

Link the current ParseUser asynchronously using LDAP authentication. Publishes when complete.

Declaration

Swift

func linkPublisher(id: String,
                   password: String,
                   options: API.Options = []) -> Future<AuthenticatedUser, ParseError>

Parameters

`id`	The id of the `user`.
`password`	The password of the user.
`options`	A set of header options sent to the server. Defaults to an empty set.

Return Value

A publisher that eventually produces a single value and then finishes or fails.


                    
                    
                    linkPublisher(authData:options:)

Link the current ParseUser asynchronously using LDAP authentication. Publishes when complete.

Declaration

Swift

func linkPublisher(authData: [String: String],
                   options: API.Options = []) -> Future<AuthenticatedUser, ParseError>

Parameters

`authData`	Dictionary containing key/values.
`options`	A set of header options sent to the server. Defaults to an empty set.

Return Value

A publisher that eventually produces a single value and then finishes or fails.

Login


                    
                    
                    login(id:password:options:callbackQueue:completion:)

Login a ParseUser asynchronously using LDAP authentication.

Declaration

Swift

func login(id: String,
           password: String,
           options: API.Options = [],
           callbackQueue: DispatchQueue = .main,
           completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void)

Parameters

`id`	The id of the `user`.
`password`	The password of the user.
`options`	A set of header options sent to the server. Defaults to an empty set.
`callbackQueue`	The queue to return to after completion. Default value of .main.
`completion`	The block to execute.


                    
                    
                    login(authData:options:callbackQueue:completion:)

Declaration

Swift

func login(authData: [String: String],
           options: API.Options = [],
           callbackQueue: DispatchQueue = .main,
           completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void)

Link


                    
                    
                    link(id:password:options:callbackQueue:completion:)

Link the current ParseUser asynchronously using LDAP authentication.

Declaration

Swift

func link(id: String,
          password: String,
          options: API.Options = [],
          callbackQueue: DispatchQueue = .main,
          completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void)

Parameters

`id`	The id of the `user`.
`password`	The password of the user.
`options`	A set of header options sent to the server. Defaults to an empty set.
`callbackQueue`	The queue to return to after completion. Default value of .main.
`completion`	The block to execute.


                    
                    
                    link(authData:options:callbackQueue:completion:)

Declaration

Swift

func link(authData: [String: String],
          options: API.Options = [],
          callbackQueue: DispatchQueue = .main,
          completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void)