DownloadGroup

open class DownloadGroup : ObjectBase

Represents a named group for offline download. Download groups are used for selecting a subset of data to be downloaded.

See also

groups parameter of OfflineDataService.download.

  • Construct a new download group with the specified name.

    Declaration

    Swift

    public init(name: String)

    Parameters

    name

    Download group name.

  • Add the names of multiple entity sets to entities. If EntitySet objects are not available at the time of configuring the download group, e.g. before calling OfflineDataService.open when using the dynamic API, you can use downloadGroup.entities.add(entitySetName) to add the name of an entity set.

    See also

    entities, EntitySet.localName.

    Declaration

    Swift

    open func add(_ entities: EntitySet...) throws

    Parameters

    rest_entities

    Entity sets with names to be added.

  • Add the name of a download group to groups.

    Declaration

    Swift

    open func addGroup(name: String) throws

    Parameters

    name

    Name of group to be added.

  • Add the names of multiple download groups to groups.

    Declaration

    Swift

    open func addGroups(_ groups: String...) throws

    Parameters

    rest_groups

    Names of groups to be added.

  • Add the names of multiple download queries to queries.

    Declaration

    Swift

    open func addQueries(_ queries: String...) throws

    Parameters

    rest_queries

    Names of queries to be added.

  • Add the name of a download query to queries.

    Declaration

    Swift

    open func addQuery(name: String) throws

    Parameters

    name

    Name of query to be added.

  • Names of entity sets that are included in this group.

    See also

    add.

    Declaration

    Swift

    @inline(__always)
public final var entities: StringSet { get }

  • Names of download groups sets that are included in this group.

    See also

    addGroup, addGroups.

    Declaration

    Swift

    @inline(__always)
public final var groups: StringSet { get }

  • Declaration

    Swift

    open func includes(_ entitySet: EntitySet) throws -> Bool

    Parameters

    entitySet

    Entity set to be checked.

    Return Value

    true if entities includes the name of the specified entitySet.

  • Declaration

    Swift

    open func includesGroup(name: String) throws -> Bool

    Parameters

    name

    Group name to be checked.

    Return Value

    true if groups includes the specified group.

  • Declaration

    Swift

    open func includesQuery(name: String) throws -> Bool

    Parameters

    name

    Query name to be checked.

    Return Value

    true if queries includes the specified query.

  • Name of this download group.

    Declaration

    Swift

    open var name: String { get }

  • Names of download queries sets that are included in this group.

    See also

    addQuery, addQueries.

    Declaration

    Swift

    @inline(__always)
public final var queries: StringSet { get }

  • Declaration

    Swift

    override open func toString() -> String

    Return Value

    A string representation of this object.