Classes and Methods

Site

The main object of the SharePlum library is Site.

class Site(url [version=Version.v2007, auth=None, authcookie=None, verify_ssl=True, ssl_version='TLSv1', huge_tree=False, timeout=None])

Main Site object used to interact with your SharePoint site.

Methods

AddList(listName, description, templateID)

Adds a list to your site with the provided name, description, and template.

Valid Templates include:

  • Announcements
  • Contacts
  • Custom List in Datasheet View
  • DataSources
  • Discussion Board
  • Document Library
  • Events
  • Form Library
  • Issues
  • Links
  • Picture Library
  • Survey
  • Tasks
DeleteList(listName)

Delete a list on your site with the provided List Name.

GetListCollection()

Returns information about the lists for the Site.

GetUsers([rowlimit=0])

Returns information on the userbase of the current Site.

List(listName, exclude_hidden_fields=False)

Returns a List object for the list with ‘listName’ on the current Site.

Sometimes internal fields can take the same DisplayName as visible fields, effectively hiding them from SharePlum. When ‘exclude_hidden_fields’ is True, these internal fields won’t be loaded.

List

The List object contains methods for interacting with SharePoint Lists. Created with Site.List().

Methods

GetListItems([view_name=None, fields=None, query=None, row_limit=0])
  • viewname - A valid View Name for the current List.
  • fields - Instead of a View we can pass the individual columns we want.
  • query - A filter we can apply.
  • rowlimit - Limit the number of rows returned
GetList()

This is already run when the List object is initialized. You can access the returned data under self.schema

GetView(viewname)

Information about the provided View Name for the current list.

GetViewCollection()

This is already run when the List object is initialized. You can access the returned data under self.views

UpdateList()

Does nothing. TODO.

UpdateListItems(data, kind)

Add or edit data on the current List.

  • data - Python Dictionary eg.:

    data = {'Movie': 'Elf', 'Length': '1h 37min'}
    
  • kind - ‘New’, ‘Update’, or ‘Delete’

When using kind=’Delete’ the data parameter becomes a list of IDs. eg.:

data = ['46', '201', '403', '456']
GetAttachmentCollection(_id)

Get a list of attachements for the row with the provided ID.

Folder

The Folder object is only usable with the REST API by specifiing site(version=Version.v2013) or greater.

class Filder(folder_name)

Attributes

contextinfo
items
files

Methods

get_file(file_name)
upload_file(content, file_name)
check_out(file_name)
check_in(file_name, comment)
delete_folder(relative_url)
delete_file(file_name)

soap

Helper class to build our SOAP requests. You shouldn’t have to use this directly.