box_search {boxr} | R Documentation |
Search Box files
Description
Search Box files
Usage
box_search(
query = "",
content_types = c("name", "description", "file_content", "comments", "tags"),
type = NULL,
file_extensions = NULL,
ancestor_folder_ids = NULL,
created_at_range = NULL,
updated_at_range = NULL,
size_range = NULL,
trash = FALSE,
owner_user_ids = NULL,
max = 200
)
box_search_files(query, ...)
box_search_folders(query, ...)
box_search_trash(query, ...)
Arguments
query |
|
content_types |
|
type |
|
file_extensions |
|
ancestor_folder_ids |
|
created_at_range |
|
updated_at_range |
|
size_range |
|
trash |
|
owner_user_ids |
|
max |
|
... |
Other arguments passed to |
Details
The Box API supports a maximum of 200 results per request. If
max > 200
, then multiple requests will be sent to retrieve and
combine 'paginated' results for you, behind the scenes.
See the box.com search description for details of the features of the service. Some notable details:
Full-text searching is the default
available for many source code file types, but not R scripts.
by default Box seaches by word/token and uses the
OR
operation e.g.box_search("this that")
is equivilant tobox_search("this OR that")
Reserved words for boolean operations
-
AND
,OR
, andNOT
(uppercase only) are interpreted as special context e.g.box_search("NOT this")
,box_search("this AND that")
-
Exact phrases can be matched
by surrounding them with double quotation marks e.g.
box_search('"this exact phrase"')
orbox_search("\"this exact phrase\"")
Searchability is not instantaneous
it can take >10 minutes for a newly uploaded file to become findable
Value
Object with S3 class boxr_object_list
.