ParseFacebook

public struct ParseFacebook<AuthenticatedUser> : ParseAuthentication where AuthenticatedUser : ParseUser

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


                    
                    
                    __type

Declaration

Swift

public static var __type: String { get }

init()
Declaration
Swift

public init()

Async/Await


                    
                    
                    login(userId:authenticationToken:expiresIn:options:)

Asynchronous

Throws

An error of type ParseError.

Declaration

Swift

func login(userId: String,
           authenticationToken: String,
           expiresIn: Int? = nil,
           options: API.Options = []) async throws -> AuthenticatedUser

Parameters

`userId`	The id from FacebookSDK.
`authenticationToken`	The `authenticationToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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(userId:accessToken:expiresIn:options:)

Asynchronous

Throws

An error of type ParseError.

Declaration

Swift

func login(userId: String,
           accessToken: String,
           expiresIn: Int? = nil,
           options: API.Options = []) async throws -> AuthenticatedUser

Parameters

`userId`	The id from FacebookSDK.
`accessToken`	The `accessToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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

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.

Return Value

An instance of the logged in ParseUser.


                    
                    
                    link(userId:authenticationToken:expiresIn:options:)

Asynchronous

Link the current ParseUser asynchronously using Facebook authentication for limited login.

Throws

An error of type ParseError.

Declaration

Swift

func link(userId: String,
          authenticationToken: String,
          expiresIn: Int? = nil,
          options: API.Options = []) async throws -> AuthenticatedUser

Parameters

`userId`	The id from FacebookSDK.
`authenticationToken`	The `authenticationToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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(userId:accessToken:expiresIn:options:)

Asynchronous

Link the current ParseUser asynchronously using Facebook authentication for graph API login.

Throws

An error of type ParseError.

Declaration

Swift

func link(userId: String,
          accessToken: String,
          expiresIn: Int? = nil,
          options: API.Options = []) async throws -> AuthenticatedUser

Parameters

`userId`	The id from FacebookSDK.
`accessToken`	The `accessToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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 Facebook authentication for graph API login.

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(userId:authenticationToken:expiresIn:options:)

Declaration

Swift

func loginPublisher(userId: String,
                    authenticationToken: String,
                    expiresIn: Int? = nil,
                    options: API.Options = []) -> Future<AuthenticatedUser, ParseError>

Parameters

`userId`	The id from FacebookSDK.
`authenticationToken`	The `authenticationToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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(userId:accessToken:expiresIn:options:)

Declaration

Swift

func loginPublisher(userId: String,
                    accessToken: String,
                    expiresIn: Int? = nil,
                    options: API.Options = []) -> Future<AuthenticatedUser, ParseError>

Parameters

`userId`	The id from FacebookSDK.
`accessToken`	The `accessToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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:)

Declaration

Swift

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

Parameters


                                authData

Dictionary containing key/values.

Return Value

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


                    
                    
                    linkPublisher(userId:authenticationToken:expiresIn:options:)

Link the current ParseUser asynchronously using Facebook authentication for limited login. Publishes when complete.

Declaration

Swift

func linkPublisher(userId: String,
                   authenticationToken: String,
                   expiresIn: Int? = nil,
                   options: API.Options = []) -> Future<AuthenticatedUser, ParseError>

Parameters

`userId`	The id from FacebookSDK.
`authenticationToken`	The `authenticationToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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(userId:accessToken:expiresIn:options:)

Link the current ParseUser asynchronously using Facebook authentication for graph API login. Publishes when complete.

Declaration

Swift

func linkPublisher(userId: String,
                   accessToken: String,
                   expiresIn: Int? = nil,
                   options: API.Options = []) -> Future<AuthenticatedUser, ParseError>

Parameters

`userId`	The id from FacebookSDK.
`accessToken`	The `accessToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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 Facebook authentication for graph API login. Publishes when complete.

Declaration

Swift

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

Parameters


                                authData

Dictionary containing key/values.

Return Value

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

Login


                    
                    
                    login(userId:authenticationToken:expiresIn:options:callbackQueue:completion:)

Declaration

Swift

func login(userId: String,
           authenticationToken: String,
           expiresIn: Int? = nil,
           options: API.Options = [],
           callbackQueue: DispatchQueue = .main,
           completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void)

Parameters

`userId`	The `Facebook userId` from FacebookSDK.
`authenticationToken`	The `authenticationToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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(userId:accessToken:expiresIn:options:callbackQueue:completion:)

Declaration

Swift

func login(userId: String,
           accessToken: String,
           expiresIn: Int? = nil,
           options: API.Options = [],
           callbackQueue: DispatchQueue = .main,
           completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void)

Parameters

`userId`	The `Facebook userId` from FacebookSDK.
`accessToken`	The `accessToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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(userId:authenticationToken:expiresIn:options:callbackQueue:completion:)

Link the current ParseUser asynchronously using Facebook authentication for limited login.

Declaration

Swift

func link(userId: String,
          authenticationToken: String,
          expiresIn: Int? = nil,
          options: API.Options = [],
          callbackQueue: DispatchQueue = .main,
          completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void)

Parameters

`userId`	The id from FacebookSDK.
`authenticationToken`	The `authenticationToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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(userId:accessToken:expiresIn:options:callbackQueue:completion:)

Link the current ParseUser asynchronously using Facebook authentication for graph API login.

Declaration

Swift

func link(userId: String,
          accessToken: String,
          expiresIn: Int? = nil,
          options: API.Options = [],
          callbackQueue: DispatchQueue = .main,
          completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void)

Parameters

`userId`	The id from FacebookSDK.
`accessToken`	The `accessToken` from FacebookSDK.
`expiresIn`	Optional expiration in seconds for Facebook login.
`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)