OnlineDataService Class Reference


                      
                      
                      init(provider:)

Construct an online data service using an online provider.

Declaration

Swift

public init(provider: OnlineODataProvider)

Parameters


                                  provider

Online provider.


                      
                      
                      acquireToken()

If this data service requires a security token, then acquire it now.

Declaration

Swift

open func acquireToken() throws


                      
                      
                      acquireToken(completionHandler:)

(Asynchronous) If this data service requires a security token, then acquire it now.

Declaration

Swift

open func acquireToken(completionHandler: @Sendable @escaping (Result<Void, Error>) -> Void)


                      
                      
                      deleteRepeatableRequest(requestID:headers:options:)

Ask the server to forget (delete) the repeatable request with the specified requestID.

Declaration

Swift

open func deleteRepeatableRequest(requestID: GuidValue, headers: HTTPHeaders, options: RequestOptions) throws

Parameters

`requestID`	Repeatability-Request-ID header value used in previous repeatable request.
`headers`	Optional request-specific headers.
`options`	Optional request-specific options.


                      
                      
                      deleteRepeatableRequest(requestID:headers:options:completionHandler:)

(Asynchronous) Ask the server to forget (delete) the repeatable request with the specified requestID.

Declaration

Swift

open func deleteRepeatableRequest(requestID: GuidValue, headers: HTTPHeaders, options: RequestOptions, completionHandler: @Sendable @escaping (Result<Void, Error>) -> Void)

Parameters

`requestID`	Repeatability-Request-ID header value used in previous repeatable request.
`headers`	Optional request-specific headers.
`options`	Optional request-specific options.


                      
                      
                      deleteRepeatableRequests(requestIDs:headers:options:)

Ask the server to forget (delete) the repeatable requests with the specified requestIDs.

Declaration

Swift

open func deleteRepeatableRequests(requestIDs: GuidValueList? = nil, headers: HTTPHeaders? = nil, options: RequestOptions? = nil) throws

Parameters

`requestIDs`	List of request IDs, or `nil` if Repeatability-Client-ID header value was used in previous repeatable requests, and for improved efficiency the bulk deletion of repeatable requests can be enabled using `ServiceOptions.repeatabilityClientID`.
`headers`	Optional request-specific headers.
`options`	Optional request-specific options.


                      
                      
                      deleteRepeatableRequests(requestIDs:headers:options:completionHandler:)

(Asynchronous) Ask the server to forget (delete) the repeatable requests with the specified requestIDs.

Declaration

Swift

open func deleteRepeatableRequests(requestIDs: GuidValueList? = nil, headers: HTTPHeaders? = nil, options: RequestOptions? = nil, completionHandler: @Sendable @escaping (Result<Void, Error>) -> Void)

Parameters

`requestIDs`	List of request IDs, or `nil` if Repeatability-Client-ID header value was used in previous repeatable requests, and for improved efficiency the bulk deletion of repeatable requests can be enabled using `ServiceOptions.repeatabilityClientID`.
`headers`	Optional request-specific headers.
`options`	Optional request-specific options.


                      
                      
                      onlineProvider

The online provider supporting this data service.

Declaration

Swift

open var onlineProvider: OnlineODataProvider { get }


                      
                      
                      serviceOptions

Service options for the associated online provider.

Declaration

Swift

open var serviceOptions: ServiceOptions { get }