SharePoint API: new types and methods

vvgrem@gmail.com · vvgrem@gmail.com · commit d559b3c92317 · 2020-12-09T22:25:25.000+02:00
diff --git a/generator/metadata/SharePoint.xml b/generator/metadata/SharePoint.xml
diff --git a/office365/sharepoint/attachments/attachmentfile_collection.py b/office365/sharepoint/attachments/attachmentfile_collection.py
@@ -43,6 +43,9 @@ def add(self, attachment_file_information):
         self.context.add_query(qry)
         return target_file
 
+    def add_using_path(self):
+        pass
+
     def get_by_filename(self, filename):
         """Retrieve Attachment file object by filename
 
diff --git a/office365/sharepoint/listitems/listItem_creation_information_using_path.py b/office365/sharepoint/listitems/listItem_creation_information_using_path.py
@@ -0,0 +1,16 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ListItemCreationInformationUsingPath(ClientValue):
+
+    def __init__(self, leaf_name, object_type, folder_path=None):
+        """
+
+        :type leaf_name: str
+        :type object_type: int
+        :type folder_path: office365.sharepoint.types.resource_path.ResourcePath
+        """
+        super().__init__()
+        self.FolderPath = folder_path
+        self.LeafName = leaf_name
+        self.UnderlyingObjectType = object_type
diff --git a/office365/sharepoint/listitems/listitem_collection_position.py b/office365/sharepoint/listitems/listitem_collection_position.py
diff --git a/office365/sharepoint/listitems/listitem_delete_parameters.py b/office365/sharepoint/listitems/listitem_delete_parameters.py
diff --git a/office365/sharepoint/lists/list.py b/office365/sharepoint/lists/list.py
@@ -12,11 +12,13 @@
 from office365.sharepoint.folders.folder import Folder
 from office365.sharepoint.forms.form_collection import FormCollection
 from office365.sharepoint.listitems.caml.caml_query import CamlQuery
+from office365.sharepoint.listitems.listItem_creation_information_using_path import ListItemCreationInformationUsingPath
 from office365.sharepoint.listitems.listitem import ListItem
 from office365.sharepoint.listitems.listItem_collection import ListItemCollection
 from office365.sharepoint.permissions.securable_object import SecurableObject
 from office365.sharepoint.views.view import View
 from office365.sharepoint.views.view_collection import ViewCollection
+from office365.sharepoint.webhooks.subscription_collection import SubscriptionCollection
 
 
 class List(SecurableObject):
@@ -110,6 +112,22 @@ def _resolve_folder_url():
             self.rootFolder.ensure_property("ServerRelativeUrl", _resolve_folder_url)
         return item
 
+    def add_item_using_path(self, leaf_name, object_type, folder_url):
+        """
+        :type leaf_name: str
+        :type object_type: int
+        :type folder_url: str
+        """
+        from office365.sharepoint.types.resource_path import ResourcePath as SPResPath
+        parameters = ListItemCreationInformationUsingPath(leaf_name, object_type, folder_path=SPResPath(folder_url))
+        item = ListItem(self.context)
+        qry = ServiceOperationQuery(self, "AddItemUsingPath", None, parameters, "parameters", item)
+        self.context.add_query(qry)
+        return item
+
+    def add_validate_update_item(self):
+        pass
+
     def get_item_by_id(self, item_id):
         """Returns the list item with the specified list item identifier.
 
@@ -199,6 +217,13 @@ def fields(self):
         else:
             return FieldCollection(self.context, ResourcePath("Fields", self.resource_path), self)
 
+    @property
+    def subscriptions(self):
+        """Gets one or more webhook subscriptions on a SharePoint list."""
+        return self.properties.get('Subscriptions',
+                                   SubscriptionCollection(self.context,
+                                                          ResourcePath("Subscriptions", self.resource_path)))
+
     @property
     def views(self):
         """Gets a value that specifies the collection of all public views on the list and personal views
diff --git a/office365/sharepoint/navigation/navigation_node_collection.py b/office365/sharepoint/navigation/navigation_node_collection.py
@@ -1,5 +1,6 @@
 from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.queries.create_entity_query import CreateEntityQuery
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
 from office365.sharepoint.navigation.navigation_node import NavigationNode
 
@@ -23,6 +24,13 @@ def add(self, create_node_info):
         self.context.add_query(qry)
         return target_node
 
+    def get_by_index(self, index):
+        target_node = NavigationNode(self.context)
+        self.add_child(target_node)
+        qry = ServiceOperationQuery(self, "GetByIndex", [index], None, None, target_node)
+        self.context.add_query(qry)
+        return target_node
+
     def get_by_id(self, node_id):
         """Gets the navigation node with the specified ID.
 
diff --git a/office365/sharepoint/publishing/portal_health_status.py b/office365/sharepoint/publishing/portal_health_status.py
@@ -1,5 +1,5 @@
 from office365.runtime.client_value import ClientValue
 
 
-class ListItemCreationInformationUsingPath(ClientValue):
+class PortalHealthStatus(ClientValue):
     pass
diff --git a/office365/sharepoint/sharing/link_invitation.py b/office365/sharepoint/sharing/link_invitation.py
diff --git a/office365/sharepoint/sitedesigns/__init__.py b/office365/sharepoint/sitedesigns/__init__.py
diff --git a/office365/sharepoint/sitedesigns/design_package_menu_contents.py b/office365/sharepoint/sitedesigns/design_package_menu_contents.py
@@ -0,0 +1,5 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class DesignPackageMenuContents(BaseEntity):
+    pass
diff --git a/office365/sharepoint/sitedesigns/site_design_creation_info.py b/office365/sharepoint/sitedesigns/site_design_creation_info.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SiteDesignCreationInfo(ClientValue):
+    pass
diff --git a/office365/sharepoint/sitedesigns/site_design_metadata.py b/office365/sharepoint/sitedesigns/site_design_metadata.py
@@ -0,0 +1,5 @@
+from office365.sharepoint.sitedesigns.site_design_creation_info import SiteDesignCreationInfo
+
+
+class SiteDesignMetadata(SiteDesignCreationInfo):
+    pass
diff --git a/office365/sharepoint/tenant/administration/site_collection_management_service.py b/office365/sharepoint/tenant/administration/site_collection_management_service.py
@@ -0,0 +1,9 @@
+from office365.runtime.resource_path import ResourcePath
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class SiteCollectionManagementService(BaseEntity):
+
+    def __init__(self, context):
+        fqn  = "Microsoft.Online.SharePoint.TenantAdministration.SiteCollectionManagementService"
+        super().__init__(context, ResourcePath(fqn))
diff --git a/office365/sharepoint/ui/applicationpages/clientPeoplePickerWebServiceInterface.py b/office365/sharepoint/ui/applicationpages/clientPeoplePickerWebServiceInterface.py
@@ -8,6 +8,28 @@ class ClientPeoplePickerWebServiceInterface(BaseEntity):
     def __init__(self, context):
         super().__init__(context)
 
+    @staticmethod
+    def get_search_results(context, searchPattern, providerID=None, hierarchyNodeID=None, entityTypes=None):
+        """
+        :type context: office365.sharepoint.client_context.ClientContext
+        :type searchPattern: str
+        :type providerID: str
+        :type hierarchyNodeID: str
+        :type entityTypes: str
+        """
+        result = ClientResult(str)
+        payload = {
+            "searchPattern": searchPattern,
+            "providerID": providerID,
+            "hierarchyNodeID": hierarchyNodeID,
+            "entityTypes": entityTypes
+        }
+        svc = ClientPeoplePickerWebServiceInterface(context)
+        qry = ServiceOperationQuery(svc, "GetSearchResults", None, payload, None, result)
+        qry.static = True
+        context.add_query(qry)
+        return result
+
     @staticmethod
     def client_people_picker_resolve_user(context, query_params, on_resolved=None):
         """
@@ -29,6 +51,7 @@ def _process_result(resp):
             result.value = "[{0}]".format(result.value)
             if callable(on_resolved):
                 on_resolved(result.value)
+
         context.after_execute(_process_result)
         return result
 
diff --git a/office365/sharepoint/views/view_collection.py b/office365/sharepoint/views/view_collection.py
@@ -1,26 +1,25 @@
-from office365.runtime.client_object_collection import ClientObjectCollection
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.runtime.resource_path_service_operation import ResourcePathServiceOperation
+from office365.sharepoint.base_entity_collection import BaseEntityCollection
 from office365.sharepoint.views.view import View
 
 
-class ViewCollection(ClientObjectCollection):
+class ViewCollection(BaseEntityCollection):
     """Represents a collection of View resources."""
 
     def __init__(self, context, resource_path=None, parent_list=None):
         """
 
         :type parent_list: office365.sharepoint.list.List or None
         """
-        super(ViewCollection, self).__init__(context, View, resource_path)
-        self._parent_list = parent_list
+        super(ViewCollection, self).__init__(context, View, resource_path, parent_list)
 
     def add(self, view_creation_information):
         """
 
         :type view_creation_information: office365.sharepoint.view_create_information.ViewCreationInformation
         """
-        view = View(self.context, None, self._parent_list)
+        view = View(self.context, None, self._parent)
         self.add_child(view)
         qry = ServiceOperationQuery(self, "Add", None, view_creation_information, "parameters", view)
         self.context.add_query(qry)
@@ -32,12 +31,16 @@ def get_by_title(self, view_title):
         :type view_title: str
         """
         return View(self.context,
-                    ResourcePathServiceOperation("GetByTitle", [view_title], self.resource_path), self._parent_list)
+                    ResourcePathServiceOperation("GetByTitle", [view_title], self.resource_path), self._parent)
 
     def get_by_id(self, view_id):
         """Gets the list view with the specified ID.
 
         :type view_id: str
         """
         return View(self.context,
-                    ResourcePathServiceOperation("GetById", [view_id], self.resource_path), self._parent_list)
+                    ResourcePathServiceOperation("GetById", [view_id], self.resource_path), self._parent)
+
+    @property
+    def parent_list(self):
+        return self._parent
diff --git a/office365/sharepoint/webhooks/subscription.py b/office365/sharepoint/webhooks/subscription.py
@@ -0,0 +1,5 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class Subscription(BaseEntity):
+    pass
diff --git a/office365/sharepoint/webhooks/subscription_collection.py b/office365/sharepoint/webhooks/subscription_collection.py
@@ -0,0 +1,9 @@
+from office365.runtime.client_object_collection import ClientObjectCollection
+from office365.sharepoint.webhooks.subscription import Subscription
+
+
+class SubscriptionCollection(ClientObjectCollection):
+    """Represents a collection of View resources."""
+
+    def __init__(self, context, resource_path=None):
+        super(SubscriptionCollection, self).__init__(context, Subscription, resource_path)
diff --git a/office365/sharepoint/webhooks/subscription_information.py b/office365/sharepoint/webhooks/subscription_information.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class SubscriptionInformation(ClientValue):
+    pass
diff --git a/tests/sharepoint/test_navigation.py b/tests/sharepoint/test_navigation.py
@@ -25,12 +25,16 @@ def test_2_create_navigation_node(self):
         self.assertIsNotNone(new_node.resource_path)
         self.__class__.target_node = new_node
 
-    def test_3_get_navigation_node(self):
+    def test_3_get_navigation_node_by_id(self):
         node_id = self.__class__.target_node.properties.get('Id')
         existing_node = self.client.web.navigation.quick_launch.get_by_id(node_id).get().execute_query()
         self.assertIsNotNone(existing_node.resource_path)
 
-    def test_4_delete_navigation_node(self):
+    def test_4_get_navigation_node_by_index(self):
+        existing_node = self.client.web.navigation.quick_launch.get_by_index(0).get().execute_query()
+        self.assertIsNotNone(existing_node.resource_path)
+
+    def test_5_delete_navigation_node(self):
         node_to_del = self.__class__.target_node
         node_to_del.delete_object().execute_query()
 
diff --git a/tests/sharepoint/test_people_picker.py b/tests/sharepoint/test_people_picker.py
@@ -0,0 +1,23 @@
+from office365.sharepoint.ui.applicationpages.clientPeoplePickerQueryParameters import ClientPeoplePickerQueryParameters
+from office365.sharepoint.ui.applicationpages.clientPeoplePickerWebServiceInterface import \
+    ClientPeoplePickerWebServiceInterface
+from settings import settings
+from tests.sharepoint.sharepoint_case import SPTestCase
+
+
+class TestSPPeoplePicker(SPTestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super(TestSPPeoplePicker, cls).setUpClass()
+
+    def test1_get_search_results(self):
+        params = ClientPeoplePickerQueryParameters(settings.get('first_account_name'))
+        result = ClientPeoplePickerWebServiceInterface.client_people_picker_resolve_user(self.client, params)
+        self.client.execute_query()
+        self.assertIsNotNone(result.value)
+
+    # def test2_get_search_results(self):
+    #    result = ClientPeoplePickerWebServiceInterface.get_search_results(self.client, "mdoe")
+    #    self.client.execute_query()
+    #    self.assertIsNotNone(result.value)
