Other Classes
The following classes are available globally.
-
Undocumented
See moreDeclaration
Swift
public final class xs_arrow_mutex : Sendable
-
Exception thrown when an error occurs during the parsing of an Open Data Protocol (OData) service metadata (CSDL) document.
See also
CsdlParser
.Declaration
Swift
open class CSDLError : DataSchemaError, @unchecked Sendable
-
Bitmask flags for
See moreCsdlParser.csdlOptions
.Declaration
Swift
public class CSDLOption
-
OData CSDL compatibility checker.
See moreDeclaration
Swift
open class CsdlCompatibilityChecker : ObjectBase
-
A list of item type
See moreCsdlReference
.Declaration
Swift
open class CsdlReferenceList : ListBase, Sequence, @unchecked Sendable
-
A list of item type
See moreAggregateExpression
.Declaration
Swift
open class AggregateExpressionList : ListBase, Sequence, @unchecked Sendable
-
Represents the ‘from’ clause in an aggregate transformation.
See moreDeclaration
Swift
open class AggregateFrom : ObjectBase, @unchecked Sendable
-
Represents the method of the aggregate transformation.
See moreDeclaration
Swift
open class AggregateMethod : ObjectBase, @unchecked Sendable
-
Declaration
Swift
open class AggregateValue : TransformValue, @unchecked Sendable
-
Abstract base class for top and bottom transformations.
See moreDeclaration
Swift
open class AmountTransform : TransformValue, @unchecked Sendable
-
Declaration
Swift
open class Annotation : ObjectBase, @unchecked Sendable
-
Declaration
Swift
open class AnnotationTerm : ObjectBase, @unchecked Sendable
-
Predefined basic types.
Declaration
Swift
public class BasicType
-
Represents the bottom* transformations.
See moreDeclaration
Swift
open class BottomTransform : AmountTransform, @unchecked Sendable
-
Abstract base class for
See morebyte
streams.Declaration
Swift
open class ByteStream : StreamBase, @unchecked Sendable
-
A token for requesting the cancellation of asynchronous requests.
See moreDeclaration
Swift
open class CancelToken : ObjectBase
-
Listener for notification of request cancellation.
See moreDeclaration
Swift
open class CancellationListener : ObjectBase
-
A list of item type
See moreCancellationListener
.Declaration
Swift
open class CancellationListenerList : ListBase, Sequence, @unchecked Sendable
-
Abstract base class for
See morechar
streams, using UTF-16 code units.Declaration
Swift
open class CharStream : StreamBase, @unchecked Sendable
-
Declaration
Swift
open class ComplexType : StructureType, @unchecked Sendable
-
A list of item type
See moreComplexType
.Declaration
Swift
open class ComplexTypeList : ListBase, Sequence, @unchecked Sendable
-
A map from key type
See morestring
to value typeComplexType
.Declaration
Swift
open class ComplexTypeMap : MapBase, @unchecked Sendable
-
Declaration
Swift
open class ComplexValue : StructureBase, ComplexValueOrList, @unchecked Sendable
-
A list of item type
See moreComplexValue
.Declaration
Swift
open class ComplexValueList : ListBase, Codable, ComplexValueOrList, Sequence, @unchecked Sendable
-
A map from key type
See morestring
to value typeComplexValue
.Declaration
Swift
open class ComplexValueMap : MapBase, @unchecked Sendable
-
Represents the ‘concat’ transformation.
See moreDeclaration
Swift
open class ConcatTransform : TransformValue, @unchecked Sendable
-
Abstract base class for data exceptions.
See moreDeclaration
Swift
open class DataError : ErrorBase, @unchecked Sendable
-
Format constants for use with data protocols.
See moreDeclaration
Swift
public class DataFormat
-
Encapsulates the application of an OData method (function or action) to a list of parameters. This is used to represent calls to actions and functions defined within an entity model, as opposed to
See moreQueryFunction
which is used to represent calls to builtin functions.Declaration
Swift
open class DataMethodCall : DataValue, @unchecked Sendable
-
A map from key type
See morestring
to value typeDataMethod
.Declaration
Swift
open class DataMethodMap : MapBase, @unchecked Sendable
-
Used together with
See moreDataQuery
to represent a select, expand or sort item which is a single-part or multi-part path expression. For example, a path whose OData URL representation is “Address/City” might be used to access the “City” property in a complex-typed “Address” property. Also used to represent paths in OData CSDL.Declaration
Swift
open class DataPath : PropertyPath, BindingPath, @unchecked Sendable
-
Exception thrown when a
See moreDataService
request fails due to a data service issue.Declaration
Swift
open class DataServiceError : DataError, @unchecked Sendable
-
Exception thrown when a
See moreDataService
request fails due to a data storage issue.Declaration
Swift
open class DataStorageError : DataError, @unchecked Sendable
-
Represents a data type defined by XML Schema Part 2: Datatypes or OData. String, binary, boolean, numeric and calendar types use XML Schema nomenclature. Geography, geometry, complex and entity types use OData nomenclature.
See moreDeclaration
Swift
open class DataType : ObjectBase, @unchecked Sendable
-
Abstract base class for wrapper classes that wrap basic data values as objects, as well as calendar values, geography values, geometry values,
ComplexValue
,EntityValue
andListBase
.See also
StringValue
,BinaryValue
,BooleanValue
,CharValue
,ByteValue
,ShortValue
,IntValue
,LongValue
,IntegerValue
,DecimalValue
,FloatValue
,DoubleValue
,UnsignedByte
,UnsignedShort
,EnumValue
,GuidValue
,LocalDate
,LocalTime
,LocalDateTime
,GlobalDateTime
,DayTimeDuration
,YearMonthDuration
,GeographyValue
,GeometryValue
.Declaration
Swift
open class DataValue : ObjectBase, Comparable, Hashable, @unchecked Sendable
-
Utility functions for date numbering.
See moreDeclaration
Swift
public class DateNumber
-
Constants to represent days of the week (Monday = 1 to Sunday = 7, using ISO 8601 conventions).
See moreDeclaration
Swift
public class DayOfWeek
-
Represents the XML Schema dayTimeDuration type.
See moreDeclaration
Swift
open class DayTimeDuration : DataValue, @unchecked Sendable
-
A list of item type
See moreDayTimeDuration
.Declaration
Swift
open class DayTimeDurationList : ListBase, Sequence, @unchecked Sendable
-
A stream of delta items, each of which is either an
EntityValue
or aChangedLink
. While processing a stream, a delta link may be encountered, but it will not be immediately available to the caller. ThedeltaLink
can be obtained only after the stream is closed.Example
See morelet deltaStream = ... while (deltaStream.next()) { if (deltaStream.hasEntity()) { let entity = deltaStream.getEntity() // Process entity value. } else { let link = deltaStream.getLink() // Process changed link. } } deltaStream.close() var deltaLink = deltaStream.deltaLink // Save delta link for later use.
Declaration
Swift
open class DeltaStream : DataValue, @unchecked Sendable
-
Encapsulates the metadata of an OData entity set. Also used for OData
isSingleton
entities.See also
DataService.createEntity
,DataService.updateEntity
,DataService.deleteEntity
,DataService.getEntity
,DataService.getEntityList
.Declaration
Swift
open class EntitySet : ObjectBase, BindingPath, @unchecked Sendable
-
Declaration
Swift
open class EntityStream : ObjectBase
-
Declaration
Swift
open class EntityType : StructureType, @unchecked Sendable
-
Declaration
Swift
open class EntityValue : StructureBase, BindingPath, EntityValueOrList, @unchecked Sendable
-
A list of item type
See moreEntityValue
.Declaration
Swift
open class EntityValueList : ListBase, Codable, EntityValueOrList, Sequence, @unchecked Sendable
-
A map from key type
See morestring
to value typeEntityValue
.Declaration
Swift
open class EntityValueMap : MapBase, @unchecked Sendable
-
Represents the ‘expand’ transformation.
See moreDeclaration
Swift
open class ExpandTransform : TransformValue, @unchecked Sendable
-
Convenience class for the abbreviated creation of expand queries with nested select/expand/filter.
See moreDeclaration
Swift
open class ExpandablePath : PropertyPath, @unchecked Sendable
-
Represents the ‘filter’ transformation.
See moreDeclaration
Swift
open class FilterTransform : TransformValue, @unchecked Sendable
-
A collection of geography values.
See moreDeclaration
Swift
open class GeographyCollection : GeographyValue, @unchecked Sendable
-
A sequence of geography points which represents a joined string of lines.
See moreDeclaration
Swift
open class GeographyLineString : GeographyValue, @unchecked Sendable
-
A sequence of geography line strings.
See moreDeclaration
Swift
open class GeographyMultiLineString : GeographyValue, @unchecked Sendable
-
A sequence of geography points.
See moreDeclaration
Swift
open class GeographyMultiPoint : GeographyValue, @unchecked Sendable
-
A sequence of geography polygons.
See moreDeclaration
Swift
open class GeographyMultiPolygon : GeographyValue, @unchecked Sendable
-
A geography point.
See moreDeclaration
Swift
open class GeographyPoint : GeographyValue, @unchecked Sendable
-
A sequence of geography multi-points which represents a polygon. The first multi-point coordinate is the exterior ring, any others are interior rings.
See moreDeclaration
Swift
open class GeographyPolygon : GeographyValue, @unchecked Sendable
-
Abstract base class for geography data values.
See also
GeographyPoint
,GeographyMultiPoint
,GeographyLineString
,GeographyMultiLineString
,GeographyPolygon
,GeographyMultiPolygon
,GeographyCollection
.Declaration
Swift
open class GeographyValue : GeospatialValue, @unchecked Sendable
-
A list of item type
See moreGeographyValue
.Declaration
Swift
open class GeographyValueList : ListBase, Sequence, @unchecked Sendable
-
A collection of geometry values.
See moreDeclaration
Swift
open class GeometryCollection : GeometryValue, @unchecked Sendable
-
A sequence of geometry points which represents a joined string of lines.
See moreDeclaration
Swift
open class GeometryLineString : GeometryValue, @unchecked Sendable
-
A sequence of geometry line strings.
See moreDeclaration
Swift
open class GeometryMultiLineString : GeometryValue, @unchecked Sendable
-
A sequence of geometry points.
See moreDeclaration
Swift
open class GeometryMultiPoint : GeometryValue, @unchecked Sendable
-
A sequence of geometry polygons.
See moreDeclaration
Swift
open class GeometryMultiPolygon : GeometryValue, @unchecked Sendable
-
A geometry point.
See moreDeclaration
Swift
open class GeometryPoint : GeometryValue, @unchecked Sendable
-
A sequence of geometry multi-points which represents a polygon.
See moreDeclaration
Swift
open class GeometryPolygon : GeometryValue, @unchecked Sendable
-
Abstract base class for geometry data values.
See also
GeometryPoint
,GeometryMultiPoint
,GeometryLineString
,GeometryMultiLineString
,GeometryPolygon
,GeometryMultiPolygon
,GeometryCollection
.Declaration
Swift
open class GeometryValue : GeospatialValue, @unchecked Sendable
-
A list of item type
See moreGeometryValue
.Declaration
Swift
open class GeometryValueList : ListBase, Sequence, @unchecked Sendable
-
A list of item type
See moreGlobalDateTime
.Declaration
Swift
open class GlobalDateTimeList : ListBase, Sequence, @unchecked Sendable
-
Represents the ‘groupby’ transformation.
See moreDeclaration
Swift
open class GroupTransform : TransformValue, @unchecked Sendable
-
Represents the ‘identity’ transformation.
See moreDeclaration
Swift
open class IdentityTransform : TransformValue, @unchecked Sendable
-
Object to discover server-only navigation properties between a source entity type, a target entity type and a join entity type. The source is the entity containing the navigation property which owns this JoinSetRelations instance. The target is the entity which is connected to the sorce entity with the navigation property. JoinSet is an entity between the source and the target. This exists only on the server side, and connects the source and the target entities.
See moreDeclaration
Swift
open class JoinSetRelations : ObjectBase
-
Represents the ‘join’ transformation.
See moreDeclaration
Swift
open class JoinTransform : TransformValue, @unchecked Sendable
-
A list of item type
See morePointCoordinates
.Declaration
Swift
open class LineStringCoordinates : ListBase, Sequence, @unchecked Sendable
-
Exception thrown when a data value literal is invalid.
See moreDeclaration
Swift
open class LiteralValueException : PanicError, @unchecked Sendable
-
A list of item type
See moreLocalDateTime
.Declaration
Swift
open class LocalDateTimeList : ListBase, Sequence, @unchecked Sendable
-
A lock for ensuring thread-safe access to mutable service metadata. See
See moreReadWriteLock
for notes regarding lock reentrancy for writers.Declaration
Swift
open class MetadataLock : ObjectBase, @unchecked Sendable
-
Constants to represent months of the year.
See moreDeclaration
Swift
public class MonthOfYear
-
A list of item type
See moreLineStringCoordinates
.Declaration
Swift
open class MultiLineStringCoordinates : ListBase, Sequence, @unchecked Sendable
-
A list of item type
See morePointCoordinates
.Declaration
Swift
open class MultiPointCoordinates : ListBase, Sequence, @unchecked Sendable
-
A list of item type
See morePolygonCoordinates
.Declaration
Swift
open class MultiPolygonCoordinates : ListBase, Sequence, @unchecked Sendable
-
Represents the ‘orderby’ transformation.
See moreDeclaration
Swift
open class OrderTransform : TransformValue, @unchecked Sendable
-
Declaration
Swift
open class Parameter : ObjectBase
-
Annotations that are associated with a CSDL target path that is a child of a CSDL model element.
See moreDeclaration
Swift
open class PathAnnotations : ObjectBase, @unchecked Sendable
-
A list of item type
See moreLineStringCoordinates
.Declaration
Swift
open class PolygonCoordinates : ListBase, Sequence, @unchecked Sendable
-
Encapsulates the metadata of an OData structural or navigation property. Used for properties of complex and entity types.
See moreDeclaration
Swift
open class Property : PropertyPath, @unchecked Sendable
-
Abstract base class for
Property
andDataPath
. Values of typePropertyPath
are typically used in query construction.See also
DataQuery.select
,DataQuery.expand
,DataQuery.orderBy
.Declaration
Swift
open class PropertyPath : QueryValue, @unchecked Sendable
-
A list of item type
See morePropertyPath
.Declaration
Swift
open class PropertyPathList : ListBase, Sequence, @unchecked Sendable
-
A map from key type
See morestring
to value typePropertyPath
.Declaration
Swift
open class PropertyPathMap : MapBase, @unchecked Sendable
-
Encapsulates the boolean value of an OData logical operator. Used to wrap the results of logical
QueryOperator
in a type-safe manner.Example using proxy classes
open func queryWithFilterExample() throws -> Void { let service = self.service let query = DataQuery() .select(Customer.customerID, Customer.companyName, Customer.contactName) .filter(Customer.country.equal("Germany") .and(Customer.contactName.greaterEqual("N"))) // Alternate syntax using convenience operators: // let query = DataQuery() // .select(Customer.customerID, Customer.companyName, Customer.contactName) // .filter(Customer.country == "Germany" && Customer.contactName >= "N") let customers = try service.fetchCustomers(matching: query) self.showCustomers(customers) }
Example using dynamic API
See moreopen func queryWithFilterExample() throws -> Void { let service = self.service let customersEntitySet = service.entitySet(withName: "Customers") let customerEntityType = customersEntitySet.entityType let customerIDProperty = customerEntityType.property(withName: "CustomerID") let companyNameProperty = customerEntityType.property(withName: "CompanyName") let contactNameProperty = customerEntityType.property(withName: "ContactName") let countryProperty = customerEntityType.property(withName: "Country") let query = DataQuery() .select(customerIDProperty, companyNameProperty, contactNameProperty) .from(customersEntitySet) .filter(countryProperty.equal("Germany") .and(contactNameProperty.greaterEqual("N"))) // Alternate syntax using convenience operators: // let query = DataQuery() // .select(customerIDProperty, companyNameProperty, contactNameProperty) // .from(customersEntitySet) // .filter(countryProperty == "Germany" && contactNameProperty >= "N") let customers = try service.executeQuery(query).entityList() self.showCustomers(customers) }
Declaration
Swift
open class QueryFilter : DataValue, @unchecked Sendable
-
Represents a OData query function. Query functions are typically used within
DataQuery.filter
.QueryFunctionCall
can be constructed using static calls onQueryFunction
or, more conveniently, by chained calls onQueryValue
.//! @example example.NorthwindProxyClient.queryFunctionExampleExample using proxy classes (with QueryValue chained calls)
See moreopen func queryValueFunctionExample() throws -> Void { let service = self.service let query = DataQuery().filter(Customer.address.toLower().contains("king")) let customers = try service.fetchCustomers(matching: query) self.showCustomers(customers) }
Declaration
Swift
open class QueryFunction : ObjectBase
-
Constants for
See moreQueryFunction.code
.Declaration
Swift
public class QueryFunctionCode
-
Represents a OData query operator. Query operators are typically used within
DataQuery.filter
.QueryOperatorCall
can be constructed using static calls onQueryOperator
or, more conveniently, by chained calls onQueryValue
.Example using proxy classes (with QueryOperator static calls)
open func queryOperatorExample() throws -> Void { let service = self.service let query = DataQuery() .filter(QueryOperator.greaterEqual(QueryOperator.multiply(OrderDetail.quantity, OrderDetail.unitPrice), DecimalValue.of(DecimalFunction.fromInt(1000)))) let details = try service.fetchOrderDetails(matching: query) self.showDetails(details) }
Example using proxy classes (with QueryValue chained calls)
See moreopen func queryValueOperatorExample() throws -> Void { let service = self.service let query = DataQuery() .filter(OrderDetail.quantity.multiply(OrderDetail.unitPrice) .greaterEqual(BigDecimal(1000))) // Alternate syntax using overloaded operators: // let query = DataQuery().filter(OrderDetail.quantity * OrderDetail.unitPrice >= 1000) let details = try service.fetchOrderDetails(matching: query) self.showDetails(details) }
Declaration
Swift
open class QueryOperator : ObjectBase
-
Constants for
See moreQueryOperator.code
.Declaration
Swift
public class QueryOperatorCode
-
Holds a data query and its result value. Allows conversion of the result to optional/required/list values for basic, complex and entity types.
See moreDeclaration
Swift
open class QueryResult : ObjectBase, @unchecked Sendable
-
Options for processing of data requests. If request options are used for
See morerepeatable
requests, a new request options object should be used for each distinct request (or the repeatability properties should be reset before object re-use). The repeated execution of a failed request should re-use the original request options object withoutrepeatable
being reset beforehand.Declaration
Swift
open class RequestOptions : ObjectBase, @unchecked Sendable
-
Declaration
Swift
open class SearchExpression : ObjectBase
-
A list of item type
See moreSearchExpression
.Declaration
Swift
open class SearchExpressionList : ListBase, Sequence, @unchecked Sendable
-
Options for
See moreSearchExpression.matches
. Reserved for future use.Declaration
Swift
open class SearchOptions : ObjectBase, @unchecked Sendable
-
Represents an OData search term (word or phrase).
See moreDeclaration
Swift
open class SearchTerm : SearchExpression
-
Represents the ‘skip’ transformation.
See moreDeclaration
Swift
open class SkipTransform : TransformValue, @unchecked Sendable
-
Declaration
Swift
open class StreamBase : DataValue, @unchecked Sendable
-
Common base class for
See moreComplexValue
andEntityValue
.Declaration
Swift
open class StructureBase : DataValue, Codable, @unchecked Sendable
-
Common base class for
See moreComplexType
andEntityType
.Declaration
Swift
open class StructureType : DataType, @unchecked Sendable
-
A list of item type
See moreStructureType
.Declaration
Swift
open class StructureTypeList : ListBase, Sequence, @unchecked Sendable
-
A map from key type
See morestring
to value typeStructureType
.Declaration
Swift
open class StructureTypeMap : MapBase, @unchecked Sendable
-
Encapsulates an OData SymbolicName as a DataValue.
See also
SymbolicName in https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Core.V1.xmlDeclaration
Swift
open class SymbolicName : DataValue, @unchecked Sendable
-
Represents the top* transformations.
See moreDeclaration
Swift
open class TopTransform : AmountTransform, @unchecked Sendable
-
Encapsulates an OData transformation defined in OData Data Aggregation. A TransformValue indicates an expression that is used in the $apply system query option.
See moreDeclaration
Swift
open class TransformValue : QueryValue, @unchecked Sendable
-
Represents the XML Schema yearMonthDuration type.
See moreDeclaration
Swift
open class YearMonthDuration : DataValue, @unchecked Sendable
-
A list of item type
See moreYearMonthDuration
.Declaration
Swift
open class YearMonthDurationList : ListBase, Sequence, @unchecked Sendable
-
A data service provider that synchronizes data between a local SQL database on a mobile client device and a remote OData service. Occasional
download
andupload
calls may be used to synchronize data changes when the mobile client device is online. The local SQL database will subsequently be queried and updated via the associatedSQLDatabaseProvider
when the mobile client device is offline. The remote OData service can be cloud-based or on-premise, but will typically be accessed via a cloud-based intermediary which enables connectivity between the mobile client device and the remote OData service. Connectivity between the mobile client device and the remote OData service can be achieved by the associatedOnlineODataProvider
via SAP Mobile Services and/or SAP BTP Connectivity. The OData service should be enabled for OData change tracking, so thatdownload
calls can efficiently obtain only the changed data. If the OData service does not support change tracking, then Mobile Back-End Tools can be used to enable change tracking, either by using a delta-enabled cache database, or by using a delta-enabled existing database. Mobile Back-end Tools can also be used to provide an OData service with a delta-enabled cache database, wrapping a non-OData backend system which is accessible using HTTPS (for REST APIs or SOAP services), JDBC (for SQL databases), or SAP Java Connector (for ABAP systems). TheEntitySet.downloadWithoutDeltaLinks
property can be set totrue
to enable client-side change tracking, however this is only appropriate for application prototyping or for production scenarios with a limited amount of data to be downloaded. Client applications should wrap this provider with aDataService
(orOfflineDataService
) for convenient consumption, including the use of async methods and proxy classes.See also
open
, client-side download queries, server-side download queries,downloadWithoutDeltaLinks
,downloadQueriesCanOverlap
,noDefaultEntityDownload
,noDefaultStreamDownload
.Example using proxy classes
open func setupService() throws -> Void { let online = OnlineODataProvider(serviceName: "HealthService", serviceRoot: "http://health.example.com:8080") let database = SQLDatabaseProvider(serviceName: "HealthDB", databaseURL: "sqlite:~/health.db") let offline = CloudSyncProvider(onlineProvider: online, offlineStore: database) offline.encryptionKey = self.dbEncryptionKey() offline.createIndex(HealthService.patients, Patient.dateOfBirth, Patient.lastName) let service = HealthService(provider: offline) service.downloadInGroup("PatientGroup", HealthService.patients, HealthService.appointments) service.downloadInGroup("StaffGroup", HealthService.doctors, HealthService.nurses) self.healthService = service }
Example using dynamic API
See moreopen func setupService() throws -> Void { let onlineProvider = OnlineODataProvider(serviceName: "HealthService", serviceRoot: "http://health.example.com:8080") let localDatabase = SQLDatabaseProvider(serviceName: "HealthDB", databaseURL: "sqlite:~/health.db") let offlineProvider = CloudSyncProvider(onlineProvider: onlineProvider, offlineStore: localDatabase) offlineProvider.encryptionKey = self.dbEncryptionKey() offlineProvider.createDynamicIndex("Patients", "dateOfBirth") self.healthService = OfflineDataService(provider: offlineProvider) try self.healthService.open() }
Declaration
Swift
open class CloudSyncProvider : ObjectBase, DataSyncProvider, ClientRegistrationProvider, @unchecked Sendable
-
Encapsulates an OData data service.
See also
DataQuery
.Example using proxy classes
open func dataServiceExample() throws -> Void { let provider = OnlineODataProvider(serviceName: "NorthwindService", serviceRoot: "http://services.odata.org/V4/Northwind/Northwind.svc/") let service = NorthwindService(provider: provider) let query = DataQuery() .select(Customer.customerID, Customer.companyName, Customer.contactName) .orderBy(Customer.companyName) let customers = try service.fetchCustomers(matching: query) self.showCustomers(customers) let customer = customers.first!.copy() customer.companyName = "Created Inc." try service.createEntity(customer) customer.companyName = "Updated Inc." try service.updateEntity(customer) try service.deleteEntity(customer) }
Example using dynamic API
See moreopen func dataServiceExample() throws -> Void { let provider = OnlineODataProvider(serviceName: "NorthwindService", serviceRoot: "http://services.odata.org/V4/Northwind/Northwind.svc/") let service = DataService(provider: provider) try service.loadMetadata() let customersEntitySet = service.entitySet(withName: "Customers") let customerEntityType = customersEntitySet.entityType let customerIDProperty = customerEntityType.property(withName: "CustomerID") let companyNameProperty = customerEntityType.property(withName: "CompanyName") let contactNameProperty = customerEntityType.property(withName: "ContactName") let query = DataQuery() .select(customerIDProperty, companyNameProperty, contactNameProperty) .from(customersEntitySet).orderBy(companyNameProperty) let customers = try service.executeQuery(query).entityList() self.showCustomers(customers) let customer = customers.first().copyEntity() companyNameProperty.setStringValue(in: customer, to: "Created Inc.") try service.createEntity(customer) companyNameProperty.setStringValue(in: customer, to: "Updated Inc.") try service.updateEntity(customer) try service.deleteEntity(customer) }
Declaration
Swift
@available(swift 5.5) open class DataServiceAsync : ObjectBase, @unchecked Sendable
-
Represents a named group for offline download. Download groups are used for selecting a subset of data to be downloaded.
See also
groups
parameter ofOfflineDataService.download
.Declaration
Swift
open class DownloadGroup : ObjectBase
-
Represents a numbered phase for offline download. Download phases are used to break downloads into phases which might have different characteristics.
See also
OfflineDataService.download
.Declaration
Swift
open class DownloadPhase : DownloadGroup
-
A query used to limit the downloading of entities with
CloudSyncProvider
.See also
OfflineDataService.createDownloadQuery
.Declaration
Swift
open class DownloadQuery : ObjectBase, @unchecked Sendable
-
A list of item type
See moreDownloadQuery
.Declaration
Swift
open class DownloadQueryList : ListBase, Sequence, @unchecked Sendable
-
Deprecated. Encapsulates an OData data service. Note: this class provides legacy-style async functions. Use
See moreDataService
,OnlineDataService
orOfflineDataService
for Swift.Result-style async functions.Declaration
Swift
open class LegacyAnyDataService : ObjectBase, @unchecked Sendable
-
Deprecated. Encapsulates an OData data service. Note: this class provides legacy-style async functions. Use
See moreDataService
,OnlineDataService
orOfflineDataService
for Swift.Result-style async functions.Declaration
Swift
open class LegacyDataService<Provider> : @unchecked Sendable where Provider : DataServiceProvider
-
Options for interaction with a data network.
See moreDeclaration
Swift
open class NetworkOptions : ObjectBase
-
A specialization of
See moreDataService
where theprovider
is aDataSyncProvider
.Declaration
Swift
open class OfflineDataService : DataService, @unchecked Sendable
-
An specialization of
See moreDataService
where theprovider
is aDataSyncProvider
, using the async/await style of asynchronous operations.Declaration
Swift
@available(swift 5.5) open class OfflineDataServiceAsync : DataServiceAsync, @unchecked Sendable
-
A specialization of
See moreDataService
where theprovider
is anOnlineODataProvider
.Declaration
Swift
open class OnlineDataService : DataService, @unchecked Sendable
-
An specialization of
See moreDataService
where theprovider
is anOnlineODataProvider
, using the async/await style of asynchronous operations.Declaration
Swift
@available(swift 5.5) open class OnlineDataServiceAsync : DataServiceAsync, @unchecked Sendable
-
Generalized operation progress information, e.g. for network download / upload operations.
See moreDeclaration
Swift
open class OperationProgress : ObjectBase
-
A list of item type
See morePendingRequest
.Declaration
Swift
open class PendingRequestList : ListBase, Sequence, @unchecked Sendable
-
Exception thrown by SQL functions when an error occurs.
See moreDeclaration
Swift
open class SQLDatabaseError : DataStorageError, @unchecked Sendable
-
An implementation of
See moreDataServiceProvider
using a SQL database. A remote OData service is not required in order to use this provider. The underlying database software is SQLite (SQLCipher).Declaration
Swift
open class SQLDatabaseProvider : ObjectBase, DataServiceProvider, @unchecked Sendable
-
Options for interaction with a data service.
See moreDeclaration
Swift
open class ServiceOptions : ObjectBase
-
Options for offline storage of data from a
See moreDataService
.Declaration
Swift
open class StorageOptions : ObjectBase
-
Contains information about a synchronization event, such as download or upload.
See moreDeclaration
Swift
open class SyncEvent : ObjectBase
-
Request options for
See moreOfflineDataService.download
andOfflineDataService.upload
.Declaration
Swift
open class SyncOptions : ObjectBase, @unchecked Sendable
-
A utility class for formatting OData values as JSON strings.
See moreDeclaration
Swift
public class ToJSON
-
Exception thrown by
DataSyncProvider.upload
when one or more pending requests cannot be uploaded due to a backend failure. Themessage
for this exception will not be localized. Please use the properties (failureCount
,successCount
,notSentCount
) for error handling and user notification.See also
OfflineDataService.getFailedRequests
, to list the failed requests after anUploadException
has been thrown.Declaration
Swift
open class UploadError : DataError, @unchecked Sendable
-
Arbitrary precision decimal value.
See moreDeclaration
Swift
open class BigDecimal : ObjectBase, @unchecked Sendable
extension BigDecimal: Equatable, Comparable
-
Arbitrary precision integer value.
See moreDeclaration
Swift
open class BigInteger : ObjectBase, @unchecked Sendable
extension BigInteger: Equatable, Comparable
-
An exception thrown if
See moreHttpRequest.send
cannot be completed due to a network error, or when one of the HTTP functions is used in an inappropriate manner or with invalid parameters.Declaration
Swift
open class HTTPError : DataNetworkError, @unchecked Sendable
-
Constants for HTTP methods.
See moreDeclaration
Swift
public class HTTPMethod
-
Constants for HTTP status code.
See moreDeclaration
Swift
public class HTTPStatus
-
Constants for HTTP status text.
See moreDeclaration
Swift
public class HTTPStatusText
-
Encapsulates a map of HTTP cookies.
See moreDeclaration
Swift
open class HTTPCookies : ObjectBase, @unchecked Sendable
-
Constants for standard and extended HTTP header names.
See moreDeclaration
Swift
open class HTTPHeader : ObjectBase
-
Encapsulates a map of HTTP headers, allowing case-insensitive lookup.
See moreDeclaration
Swift
open class HTTPHeaders : ObjectBase, @unchecked Sendable
-
Utility functions for asserting/converting query result into a single item.
See moreDeclaration
Swift
public class Single