SharePoint API: new types and methods

Author: vvgrem@gmail.com

examples/sharepoint/files/upload_file.py

@@ -14,7 +14,7 @@
     file_content = content_file.read()
 
 list_title = "Documents"
-target_folder = ctx.web.lists.get_by_title(list_title).rootFolder
+target_folder = ctx.web.lists.get_by_title(list_title).root_folder
 name = os.path.basename(path)
 target_file = target_folder.upload_file(name, file_content)
 ctx.execute_query()

examples/sharepoint/folders/download_folder.py

@@ -11,7 +11,7 @@
                      settings['client_credentials']['client_secret']))
 
 # retrieve files from library
-files = ctx.web.lists.get_by_title("Documents").rootFolder.files
+files = ctx.web.lists.get_by_title("Documents").root_folder.files
 ctx.load(files)
 ctx.execute_query()
 download_path = tempfile.mkdtemp()

examples/sharepoint/lists_and_items/data_generator.py

@@ -33,7 +33,7 @@ def generate_documents(context):
     for idx in range(0, total_amount):
         # 1. Create a folder
         folder_name = fake.date()
-        target_folder = lib.rootFolder.add(folder_name)
+        target_folder = lib.root_folder.add(folder_name)
         context.execute_query()
         print("({0} of {1}) Folder '{2}' has been created".format(idx, total_amount, target_folder.serverRelativeUrl))
 

examples/sharepoint/lists_and_items/read_attachments.py

@@ -22,7 +22,7 @@
 for item in items:
     if item.properties['Attachments']:  # 1. determine whether ListItem contains attachments
         # 2. Explicitly load attachments for ListItem
-        attachment_files = item.attachmentFiles
+        attachment_files = item.attachment_files
         ctx.load(attachment_files)
         ctx.execute_query()
         # 3. Enumerate and save attachments

examples/sharepoint/simulate_long_running_task.py

@@ -0,0 +1,21 @@
+import time
+from settings import settings
+from office365.runtime.auth.client_credential import ClientCredential
+from office365.sharepoint.client_context import ClientContext
+
+
+def process_site(context):
+    target_web = context.web
+    target_web.set_property("Description", "DEV site").update().get().execute_query()
+    print(target_web.url)
+
+
+credentials = ClientCredential(settings.get('client_credentials').get('client_id'),
+                               settings.get('client_credentials').get('client_secret'))
+ctx = ClientContext(settings['url']).with_credentials(credentials)
+
+if __name__ == '__main__':
+    while 1:
+        print(f"{time.ctime()}: Processing site")
+        process_site(ctx)
+        time.sleep(10)

office365/sharepoint/alerts/__init__.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class Alert(BaseEntity):
+    pass

office365/sharepoint/alerts/alert.py

@@ -0,0 +1,21 @@
+from office365.runtime.client_object_collection import ClientObjectCollection
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
+from office365.sharepoint.alerts.alert import Alert
+
+
+class AlertCollection(ClientObjectCollection):
+    """Content Type resource collection"""
+
+    def __init__(self, context, resource_path=None):
+        super(AlertCollection, self).__init__(context, Alert, resource_path)
+
+    def add(self, parameters):
+        """
+
+        :type parameters: office365.sharepoint.alerts.alert_creation_information.AlertCreationInformation
+        """
+        alert = Alert(self.context, None)
+        self.add_child(alert)
+        qry = ServiceOperationQuery(self, "Add", None, parameters, "alertCreationInformation", alert)
+        self.context.add_query(qry)
+        return alert

office365/sharepoint/alerts/alert_collection.py

@@ -0,0 +1,10 @@
+from office365.runtime.client_value import ClientValue
+
+
+class AlertCreationInformation(ClientValue):
+
+    def __init__(self, alert_frequency, template_name, alert_type):
+        super().__init__()
+        self.AlertFrequency = alert_frequency
+        self.AlertTemplateName = template_name
+        self.AlertType = alert_type

office365/sharepoint/alerts/alert_creation_information.py

@@ -0,0 +1,20 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ChangeLogItemQuery(ClientValue):
+
+    def __init__(self, change_token=None, contains=None, row_limit=None):
+        """
+
+        :type change_token: str
+        :type contains: str
+        :type row_limit: str
+        """
+        super().__init__()
+        self.ChangeToken = change_token
+        self.Contains = contains
+        self.RowLimit = row_limit
+
+    @property
+    def entity_type_name(self):
+        return 'SP.ChangeLogItemQuery'