
                    
                    
                    apex(method:namespace:relativePath:queryItems:headers:body:validator:decoder:session:allowsLogin:)

Represents a call to an Apex class exposed as a REST service.

You can expose your Apex class and methods so that external applications can access your code and your application through the REST architecture. This is done by defining your Apex class with the @RestResource annotation to expose it as a REST resource. Similarly, add annotations to your methods to expose them through REST. For example, you can add the @HttpGet annotation to your method to expose it as a REST resource that can be called by an HTTP GET request.

Declaration

Swift

func apex<T>(
    method: String? = nil,
    namespace: String? = nil,
    relativePath: String,
    queryItems: [URLQueryItem]? = nil,
    headers: [String:String]? = nil,
    body: Data? = nil,
    validator: Validator = .default,
    decoder: JSONDecoder = .salesforce,
    session: URLSession = .shared,
    allowsLogin: Bool = true
) -> AnyPublisher<T, Error> where T: Decodable

Parameters

`method`	Name of the Apex method to call.
`namespace`	Managed package namespace, if any. Optional.
`relativePath`	Path to the Apex REST service, as defined in the `urlMapping` of the `@RestResource` annotation on the target class.
`queryItems`	Optional query items to include in the request.
`headers`	Optional `HTTP` headers to include in the request.
`body`	Request body for a `POST` , `PATCH` or `PUT` request.
`validator`	Validator to validate the server response.
`decoder`	JSON decoder to use to decode the results.
`session`	URL session for the request.
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

Pubisher # Reference Introduction to Apex REST


                    
                    
                    identity(session:allowsLogin:)

Gets information about the current user

Declaration

Swift

func identity(session: URLSession = .shared, allowsLogin: Bool = true) -> AnyPublisher<Identity, Error>

Parameters

`session`	URL session for the request.
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

Publisher.


                    
                    
                    limits(session:allowsLogin:)

Undocumented

Declaration

Swift

func limits(session: URLSession = .shared, allowsLogin: Bool = true) -> AnyPublisher<[String : Limit], Error>


                    
                    
                    query(soql:batchSize:session:allowsLogin:)

Performs a query

Declaration

Swift

func query<T: Decodable>(
    soql: String,
    batchSize: Int = 2000,
    session: URLSession = .shared,
    allowsLogin: Bool = true
) -> AnyPublisher<QueryResult<T>, Error>

Parameters

`soql`	A SOQL query.
`batchSize`	A numeric value that specifies the number of records returned for a query request. Child objects count toward the number of records for the batch size. For example, in relationship queries, multiple child objects are returned per parent row returned. The default is 2,000; the minimum is 200, and the maximum is 2,000. There is no guarantee that the requested batch size is the actual batch size. Changes are made as necessary to maximize performance.
`session`	URL session for the request.
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

Publisher of QueryResult of Decodable instances. # Reference


                    
                    
                    nextResultPage(at:session:allowsLogin:)

Retrieves the next page of query results.

If the initial query returns only part of the results, the QueryResult will contain a value in nextRecordsPath which can be used as the path argument for this method.

Declaration

Swift

func nextResultPage<T: Decodable>(
    at path: String,
    session: URLSession = .shared,
    allowsLogin: Bool = true
) -> AnyPublisher<QueryResult<T>, Error>

Parameters

`path`	The path to the next page of query results, as returned by the previous call to `query` or `nextResultPage`.
`session`	URL session for the request.
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

Publisher of QueryResult of Decodable instances. # Reference Execute a SOQL Query


                    
                    
                    myRecords(type:fields:limit:batchSize:user:session:allowsLogin:)

Queries all records of the specified type which are owned by the user.

Declaration

Swift

func myRecords<T: Decodable>(
    type: String,
    fields: [String]? = nil,
    limit: Int? = nil,
    batchSize: Int = 2000,
    user: UserIdentifier? = nil,
    session: URLSession = .shared,
    allowsLogin: Bool = true
) -> AnyPublisher<QueryResult<T>, Error>

Parameters

`type`	Type of record (e.g. `Account`, `Contact` or `MyCustomObject__c`) which has an `OwnerId` field.
`fields`	Fields to retrieve. If nil, then all fields will be retrieved.
`limit`	The maximum number of rows to return.
`batchSize`	The batch size for a query determines the number of rows that are returned in the query results.
`user`	Specified user, or nil to use the last authenticated user.
`session`	URL session for the request.
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

Publisher of QueryResult of Decodable instances.

# Reference Frequently-Occurring Fields


                    
                    
                    retrieve(type:id:fields:session:allowsLogin:)

Retrieves a Salesforce record

Declaration

Swift

func retrieve<T>(type: String, id: String, fields: [String]? = nil, session: URLSession = .shared, allowsLogin: Bool = true) -> AnyPublisher<T, Error> where T : Decodable

Parameters

`type`	Type of record (e.g. “Account”, “Contact” or “MyCustomObject__c”).
`id`	Unique ID of the record; 15 or 18 characters.
`fields`	Fields to retrieve. If nil, then all fields will be retrieved.
`session`	URL session for the request.
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

Publisher of a Decodable record # Reference Working with Records


                    
                    
                    insert(type:fields:session:allowsLogin:)

Inserts a Salesforce record

Declaration

Swift

func insert<T>(type: String, fields: [String : T], session: URLSession = .shared, allowsLogin: Bool = true) -> AnyPublisher<String, Error> where T : Encodable

Parameters

`type`	Type of record (e.g. `Account`, `Contact` or `MyCustomObject__c`).
`fields`	Dictionary of fields names and values to insert.
`session`	URL session for the request.
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

Publisher that emits the ID of the successfully-inserted record, or an error.


                    
                    
                    update(type:id:fields:session:allowsLogin:)

Updates a Salesforce record

Declaration

Swift

func update<T>(type: String, id: String, fields: [String : T], session: URLSession = .shared, allowsLogin: Bool = true) -> AnyPublisher<Void, Error> where T : Encodable

Parameters

`type`	Type of record (e.g. `Account`, `Contact` or `MyCustomObject__c`).
`id`	Unique ID of the record; 15 or 18 characters.
`fields`	Dictionary of fields names and values to update.
`session`	URL session for the request.
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

Publisher.


                    
                    
                    delete(type:id:session:allowsLogin:)

Deletes a Salesforce record

Declaration

Swift

func delete(type: String, id: String, session: URLSession = .shared, allowsLogin: Bool = true) -> AnyPublisher<Void, Error>

Parameters

`type`	Type of record (e.g. `Account`, `Contact` or `MyCustomObject__c`).
`id`	Unique ID of the record; 15 or 18 characters.
`session`	URL session for the request.
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

Publisher.


                    
                    
                    describe(type:session:allowsLogin:)

Retrieves metadata about a Salesforce object

Declaration

Swift

func describe(type: String, session: URLSession = .shared, allowsLogin: Bool = true) -> AnyPublisher<ObjectDescription, Error>

Parameters

`type`	Type of record (e.g. `Account`, `Contact` or `MyCustomObject__c`).
`session`	URL session for the request.
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

Publisher of metadata about the object. # Reference sObject Describe


                    
                    
                    describeAll(session:allowsLogin:)

Describes all accessible objects in the user’s Salesforce org

Declaration

Swift

func describeAll(session: URLSession = .shared, allowsLogin: Bool = true) -> AnyPublisher<[ObjectDescription], Error>

Parameters

`session`	URL session for the request.
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

Publisher of an array of object metadata.


                    
                    
                    init(url:)

Initializes a Connected App representation

Throws

Error if the JSON configuration data cannot be decoded.

Declaration

Swift

init(url: URL? = nil) throws

Parameters

url

URL to JSON configuration file. If nil, a file called Salesforce.json in the main app bundle is used by default.


                    
                    
                    init(consumerKey:callbackURL:defaultAuthHost:)

Initializes a Connected App representation

Reference

Customize Your Login Process with My Domain

Declaration

Swift

init(consumerKey: String, callbackURL: URL, defaultAuthHost: String = "login.salesforce.com")

Parameters

`consumerKey`	The consumer key from your Connected App definition
`callbackURL`	The callback URL from your Connected App definition
`defaultAuthHost`	Hostname for OAuth authentication. Default is “login.salesforce.com”. For sandbox orgs use “test.salesforce.com” or for a custom domain use, for example “somethingReallycool.my.salesforce.com”


                    
                    
                    logIn()

Logs in a new user and returns the new credential

Declaration

Swift

func logIn() -> AnyPublisher<Credential, Error>

Return Value

Publisher


                    
                    
                    logOut(user:)

Revokes a user’s refresh and/or access tokens and clears the credential from the local, secure cache.

Reference

Declaration

Swift

func logOut(user: UserIdentifier? = nil) -> AnyPublisher<Void, Error>

Parameters


                                user

Identifier for the specified user or, if nil, the last authenticated user. (UserIdentifier is an alias for the user’s identity URL.)

Return Value

A publisher that completes when the underlying OAuth2 token revoke request completes.


                    
                    
                    getCredential(for:allowsLogin:)

Gets the Credential for the specified user or, if no user is specified, then for the last authenticated user.

Declaration

Swift

func getCredential(for user: UserIdentifier? = nil, allowsLogin: Bool = true) -> AnyPublisher<Credential, Error>

Parameters

`user`	Identifier for the specified user or, if nil, the last authenticated user. (UserIdentifier is an alias for the user’s identity URL.)
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.

Return Value

A publisher of a Credential # Reference


                    
                    
                    go(service:session:user:allowsLogin:validator:decoder:)

Executes an asynchronous request for data from a Salesforce API endpoint. You will likely not need to call this method directly.

Declaration

Swift

func go<S, Output>(
    service: S,
    session: URLSession = URLSession.shared,
    user: UserIdentifier? = nil,
    allowsLogin: Bool = true,
    validator: Validator = .default,
    decoder: JSONDecoder = .salesforce
) -> AnyPublisher<Output, Error> where S: Service, Output: Decodable

Parameters

`service`	Service
`session`	URL session
`user`	User identifier
`allowsLogin`	If authentication is required and allowsLogin is true, the user will be prompted to authenticate via the Salesforce-hosted web login form.
`validator`	Validator
`decoder`	JSON decoder

Return Value

Publisher of decoded output

ConnectedApp

Reference

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Reference

Declaration

Parameters

Declaration

Return Value

Reference

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value