list_sp_drives()
loads a SharePoint site uses the list_drives
method to
returns a data frame with a list column or ms_drive
objects or, if
as_data_frame = FALSE
. This is helpful if a drive has been renamed and
can't easily be identified using a Drive URL alone.
Usage
list_sp_drives(
...,
site = NULL,
filter = NULL,
n = NULL,
as_data_frame = TRUE,
call = caller_env()
)
Arguments
- ...
Arguments passed on to
get_sp_site
site_url
A SharePoint site URL in the format "https://[tenant name].sharepoint.com/sites/[site name]". Any SharePoint item or document URL can also be parsed to build a site URL using the tenant and site name included in the URL.
site_name,site_id
Site name or ID of the SharePoint site as an alternative to the SharePoint site URL. Exactly one of
site_url
,site_name
, andsite_id
must be supplied.refresh
If
TRUE
, get a new site even if the existing site is cached as a local option. IfFALSE
, use the cachedms_site
object.cache
If
TRUE
, cache site to a file usingcache_sp_site()
.cache_file
File name for cached file if
cache = TRUE
. Defaults to"sp_site.rds"
or option set withsharepointr.cache_file_site
.overwrite
If
TRUE
, replace the existing cached object named bycache_file
with the new object. IfFALSE
, error if a cached file with the samecache_file
name already exists.
- site
A
ms_site
object. Ifsite
is supplied,site_url
,site_name
, andsite_id
are ignored.- filter
Filter to apply to query
- n
Max number of drives to return
- as_data_frame
If
TRUE
(default), return list as a data frame.- call
The execution environment of a currently running function, e.g.
caller_env()
. The function will be mentioned in error messages as the source of the error. See thecall
argument ofabort()
for more information.