SourceOptionsFolder

public struct SourceOptionsFolder : Codable, Equatable

Object that defines a box folder to crawl with this configuration.

  • The Box user ID of the user who owns the folder to crawl.

    Declaration

    Swift

    public var ownerUserID: String
  • The Box folder ID of the folder to crawl.

    Declaration

    Swift

    public var folderID: String
  • The maximum number of documents to crawl for this folder. By default, all documents in the folder are crawled.

    Declaration

    Swift

    public var limit: Int?
  • Initialize a SourceOptionsFolder with member variables.

    Declaration

    Swift

    public init(
        ownerUserID: String,
        folderID: String,
        limit: Int? = nil
    )

    Parameters

    ownerUserID

    The Box user ID of the user who owns the folder to crawl.

    folderID

    The Box folder ID of the folder to crawl.

    limit

    The maximum number of documents to crawl for this folder. By default, all documents in the folder are crawled.

    Return Value

    An initialized SourceOptionsFolder.