Create a SharePoint List — create_sp

create_sp_list() allows the creation of a SharePoint list for a site. See: https://learn.microsoft.com/en-us/graph/api/list-create?view=graph-rest-1.0&tabs=http Note: dashes (`"-"“) in list names are removed from the list name but retained in the list display name.

update_sp_list() allows the modification of the list display name and description.

delete_sp_list() deletes an existing list and requires user confirmation by default.

Usage

create_sp_list(
  list_name,
  ...,
  description = NULL,
  columns = NULL,
  template = "genericList",
  content_types = NULL,
  hidden = NULL,
  title_definition = list(required = FALSE),
  site_url = NULL,
  site = NULL,
  call = caller_env()
)

update_sp_list(
  list_name = NULL,
  list_id = NULL,
  sp_list = NULL,
  display_name = NULL,
  description = NULL,
  ...,
  site_url = NULL,
  site = NULL,
  drive_name = NULL,
  drive_id = NULL,
  drive = NULL,
  call = caller_env()
)

delete_sp_list(
  list_name = NULL,
  list_id = NULL,
  sp_list = NULL,
  confirm = TRUE,
  ...,
  site_url = NULL,
  site = NULL,
  drive_name = NULL,
  drive_id = NULL,
  drive = NULL,
  call = caller_env()
)

Arguments

list_name: Required. List name used as displayName property.
...: Additional parameters passed to get_sp_site() or Microsoft365R::get_sharepoint_site().
description: Optional description.
columns: Optional. Use create_column_definition() to create a single column definition or use create_column_definition_list() to create a list of column definitions.
template: Type of template to use in creating the list.
content_types: Optional. Set TRUE for contentTypesEnabled to be enabled.
hidden: Optional. Set TRUE for list to be hidden.
title_definition: Named list used to update the column definition of the default "Title" column created when using the "genericList" template. By default, makes Title column optional.
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: A ms_site object. If site is supplied, site_url, site_name, and site_id are ignored.
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 the call argument of abort() for more information.
list_id: List ID for list to update or delete.
sp_list: A Microsoft365R::ms_list object.
display_name: Display name to replace existing display name. Used by update_sp_list().
drive_name, drive_id: SharePoint Drive name or ID passed to get_drive method for SharePoint site object.
drive: A ms_drive object. If drive is supplied, drive_name and drive_id are ignored.
confirm: If TRUE, confirm deletion of list before proceeding.