OfflineODataDefiningQuery

public struct OfflineODataDefiningQuery

A defining query is an OData read request that targets the OData backend associated with the OfflineODataProvider and retrieves a subset of the OData backend data. Multiple defining queries can be defined for each OData backend. Defining queries are a subset of data from the OData backend that is sent to the client either during the initial open of the OfflineODataProvider or during a download.

  • The name of the defining query.

    Declaration

    Swift

    public var name: String

  • The URL string for the defining query

    Declaration

    Swift

    public var query: String

  • If the defining query identifies one or more sets that contain media entities (entities with an associated media stream), this property indicates whether or not the associated media streams should be retrieved and included in the Offline store.

    Declaration

    Swift

    public var automaticallyRetrievesStreams: Bool

  • If the defining query is currently being removed

    Declaration

    Swift

    public var isRemoving: Bool

  • Initializes a defining query.

    Declaration

    Swift

    public init(name: String, query: String, automaticallyRetrievesStreams: Bool)

    Parameters

    name

    The name of the defining query.
    query

    The URL string of the defining query.
    automaticallyRetrievesStreams

    Whether or not the query should automatically retrieve streams.

    Return Value

    Instance of OfflineODataDefiningQuery.

  • Initializes a defining query.

    Declaration

    Swift

    public init(name: String, query: DataQuery, automaticallyRetrievesStreams: Bool)

    Parameters

    name

    The name of the defining query.
    query

    The DataQuery that constructs the defining query.
    automaticallyRetrievesStreams

    Whether or not the query should automatically retrieve streams.

    Return Value

    Instance of OfflineODataDefiningQuery.