ms_drive_item: File or folder in a drive

In hongooi73/SharePointR: Interface to Microsoft's 'SharePoint' and 'OneDrive' Cloud Services

Description

Class representing an item (file or folder) in a OneDrive or SharePoint document library.

Format

An R6 object of class ms_drive_item, inheriting from ms_object.

Fields

• token: The token used to authenticate with the Graph host.

• tenant: The Azure Active Directory tenant for the parent drive.

• type: always "drive item" for a drive item object.

• properties: The item properties (metadata).

Methods

• new(...): Initialize a new object. Do not call this directly; see 'Initialization' below.

• delete(confirm=TRUE): Delete this item. By default, ask for confirmation first.

• update(...): Update the item's properties (metadata) in Microsoft Graph.

• do_operation(...): Carry out an arbitrary operation on the item.

• sync_fields(): Synchronise the R object with the item metadata in Microsoft Graph.

• open(): Opens the item in your browser.

Initialization

Creating new objects of this class should be done via the get_item_properties method of the ms_drive class. Calling the new() method for this class only constructs the R object; it does not call the Microsoft Graph API to retrieve or create the actual item.

See Also

ms_graph, ms_site, ms_drive

Microsoft Graph overview, OneDrive API reference

Examples

## Not run: 

# personal OneDrive
gr2 <- get_graph_login("consumers")
me <- gr2$get_user()
mydrv <- me$get_drive()

myfile <- drv$get_item_properties("myfile.docx")
myfile$properties

# rename a file
myfile$update(name="newname.docx")

# open the file in the browser
myfile$open()

# delete the file (will ask for confirmation first)
myfile$delete()



## End(Not run)

hongooi73/SharePointR documentation built on Jan. 7, 2021, 10:42 p.m.