Include

public struct Include : OptionSet

The Query.Include is parameter for including count, Unpublished, ContentType schema, Global Fields schema, and Reference ContentType Uid in result.

Show on GitHub

  • Creates a new option set from the given raw value.

    Declaration

    Swift

    public init(rawValue: Int)

    Parameters

    rawValue

    The raw value of the option set to create. Each bit of rawValue potentially represents an element of the Query.Include, though raw values may include bits that are not defined as distinct values of the Query.Include type.
    Show on GitHub

  • Each bit of rawValue potentially represents an element of the option set

    Declaration

    Swift

    public let rawValue: Int
    Show on GitHub

  • To include count in the response.

    Declaration

    Swift

    public static let count: Include
    Show on GitHub

  • To include Unpublished Entries in response,

    Declaration

    Swift

    public static let unpublished: Include
    Show on GitHub

  • To include ContentType schema in Entry response,

    Declaration

    Swift

    public static let contentType: Include
    Show on GitHub

  • To include Global Fields schema in Entry response,

    Declaration

    Swift

    public static let globalField: Include
    Show on GitHub

  • To include Reference ContentType Uid in reference field in Entry response,

    Declaration

    Swift

    public static let refContentTypeUID: Include
    Show on GitHub

  • Retrieve the published content of the fallback locale if an entry is not localized in specified locale.

    Declaration

    Swift

    public static let fallback: Include
    Show on GitHub

  • Include Embedded Objects (Entries and Assets) along with entry/entries details.

    Declaration

    Swift

    public static let embeddedItems: Include
    Show on GitHub
  • all

    To inclide all Query.Include values.

    Declaration

    Swift

    public static let all: Include
    Show on GitHub