SharePoint API: publishing, methods types

vvgrem@gmail.com · vvgrem@gmail.com · commit 6a6919bbc00b · 2020-11-15T23:25:47.000+02:00
diff --git a/generator/metadata/SharePoint.xml b/generator/metadata/SharePoint.xml
diff --git a/office365/sharepoint/administration/__init__.py b/office365/sharepoint/administration/__init__.py
diff --git a/office365/sharepoint/administration/org_assets.py b/office365/sharepoint/administration/org_assets.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class OrgAssets(ClientValue):
+    pass
diff --git a/office365/sharepoint/fields/field.py b/office365/sharepoint/fields/field.py
@@ -77,6 +77,22 @@ def delete_object(self):
         self.remove_from_parent_collection()
         return self
 
+    @property
+    def id(self):
+        """Gets a value that specifies the field identifier.
+
+        :rtype: str or None
+        """
+        return self.properties.get('Id', None)
+
+    @property
+    def title(self):
+        """Gets or sets a value that specifies the display name of the field.
+
+        :rtype: str or None
+        """
+        return self.properties.get('Title', None)
+
     @property
     def internal_name(self):
         """Gets a value that specifies the field internal name.
diff --git a/office365/sharepoint/fields/fieldGeolocationValue.py b/office365/sharepoint/fields/fieldGeolocationValue.py
@@ -2,4 +2,15 @@
 
 
 class FieldGeolocationValue(ClientValue):
-    pass
+
+    def __init__(self, latitude, longitude, altitude=None):
+        """
+        :param float latitude: Specifies the latitude value for Geolocation field.
+        :param float longitude: Specifies the longitude value for Geolocation field.
+        :param float altitude: Specifies the altitude value for Geolocation field. It is a user defined value
+
+        """
+        super().__init__()
+        self.Latitude = latitude
+        self.Longitude = longitude
+        self.Altitude = altitude
diff --git a/office365/sharepoint/publishing/file_picker_options.py b/office365/sharepoint/publishing/file_picker_options.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class FilePickerOptions(ClientValue):
+    pass
diff --git a/office365/sharepoint/publishing/navigation/__init__.py b/office365/sharepoint/publishing/navigation/__init__.py
diff --git a/office365/sharepoint/publishing/primary_city_time.py b/office365/sharepoint/publishing/primary_city_time.py
@@ -0,0 +1,5 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class PrimaryCityTime(BaseEntity):
+    pass
diff --git a/office365/sharepoint/publishing/sitePage.py b/office365/sharepoint/publishing/sitePage.py
diff --git a/office365/sharepoint/publishing/site_page.py b/office365/sharepoint/publishing/site_page.py
@@ -0,0 +1,65 @@
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
+from office365.runtime.queries.update_entity_query import UpdateEntityQuery
+from office365.sharepoint.publishing.site_page_metadata import SitePageMetadata
+
+
+class SitePage(SitePageMetadata):
+    """Represents a site Page."""
+
+    def checkout_page(self):
+        """Checks out the current Site Page if it is available to be checked out."""
+        site_page = SitePage(self.context)
+        qry = ServiceOperationQuery(self, "CheckoutPage", None, None, None, site_page)
+        self.context.add_query(qry)
+        return site_page
+
+    def copy(self):
+        """Creates a copy of the current Site Page and returns the resulting new SitePage."""
+        qry = ServiceOperationQuery(self, "Copy", None, None, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def discard_page(self):
+        """Discards the current checked out version of the Site Page.  Returns the resulting SitePage after discard."""
+        qry = ServiceOperationQuery(self, "DiscardPage", None, None, None, None)
+        self.context.add_query(qry)
+        return self
+
+    def save_page(self, page_stream):
+        """
+        Updates the current Site Page with the provided pageStream content.
+
+        :param str page_stream: The binary stream to save for the current Site Page.
+        :return:
+        """
+        pass
+
+    def save_page_as_draft(self, page_stream):
+        """
+        Updates the Site Page with the provided pageStream content and checks in a minor version if the page library
+        has minor versions enabled.
+
+        :param str page_stream: The binary stream to save for the current Site Page.
+        :return:
+        """
+        pass
+
+    def save_page_as_template(self):
+        pass
+
+    def publish(self):
+        """
+        Publishes a major version of the current Site Page.  Returns TRUE on success, FALSE otherwise.
+
+        :return:
+        """
+        pass
+
+    def share_page_preview_by_email(self, message, recipient_emails):
+        pass
+
+    def update(self):
+        """Updates the Site page."""
+        qry = UpdateEntityQuery(self)
+        self.context.add_query(qry)
+        return self
diff --git a/office365/sharepoint/publishing/site_page_metadata.py b/office365/sharepoint/publishing/site_page_metadata.py
diff --git a/office365/sharepoint/publishing/site_page_metadata_collection.py b/office365/sharepoint/publishing/site_page_metadata_collection.py
@@ -0,0 +1,9 @@
+from office365.runtime.client_object_collection import ClientObjectCollection
+from office365.sharepoint.publishing.site_page_metadata import SitePageMetadata
+
+
+class SitePageMetadataCollection(ClientObjectCollection):
+
+    def __init__(self, context, resource_path=None):
+        """Specifies a collection of site pages."""
+        super(SitePageMetadataCollection, self).__init__(context, SitePageMetadata, resource_path)
diff --git a/office365/sharepoint/publishing/site_page_service.py b/office365/sharepoint/publishing/site_page_service.py
@@ -0,0 +1,117 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.queries.service_operation_query import ServiceOperationQuery
+from office365.runtime.queries.update_entity_query import UpdateEntityQuery
+from office365.runtime.resource_path import ResourcePath
+from office365.sharepoint.administration.org_assets import OrgAssets
+from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.files.file import File
+from office365.sharepoint.publishing.file_picker_options import FilePickerOptions
+from office365.sharepoint.publishing.primary_city_time import PrimaryCityTime
+from office365.sharepoint.publishing.site_page_metadata_collection import SitePageMetadataCollection
+
+
+class SitePageService(BaseEntity):
+
+    def __init__(self, context):
+        """Represents a set of APIs to use for managing site pages."""
+        super().__init__(context, ResourcePath("SP.Publishing.SitePageService"))
+
+    def pages(self):
+        return self.properties.get("pages",
+                                   SitePageMetadataCollection(self.context, ResourcePath("pages", self.resource_path)))
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.SitePageService"
+
+    @staticmethod
+    def get_time_zone(context, city_name):
+        """
+        Gets time zone data for specified city.
+
+        :param office365.sharepoint.client_context.ClientContext context:
+        :param str city_name: The name of the city.
+        :return: PrimaryCityTime
+        """
+        return_type = PrimaryCityTime(context)
+        svc = SitePageService(context)
+        params = {"cityName": city_name}
+        qry = ServiceOperationQuery(svc, "GetTimeZone", params, None, None, return_type)
+        qry.static = True
+        context.add_query(qry)
+        return return_type
+
+    @staticmethod
+    def compute_file_name(context, title):
+        """
+
+        :param office365.sharepoint.client_context.ClientContext context: Client context
+        :param str title: The title of the page.
+        """
+        return_type = ClientResult(None)
+        svc = SitePageService(context)
+        params = {"title": title}
+        qry = ServiceOperationQuery(svc, "ComputeFileName", params, None, None, return_type)
+        qry.static = True
+        context.add_query(qry)
+        return return_type
+
+    @staticmethod
+    def get_available_full_page_applications():
+        pass
+
+    @staticmethod
+    def get_current_user_memberships():
+        pass
+
+    @staticmethod
+    def is_file_picker_external_image_search_enabled():
+        pass
+
+    @staticmethod
+    def org_assets(context):
+        """
+
+        :param office365.sharepoint.client_context.ClientContext context: Client context
+        """
+        return_type = OrgAssets()
+        svc = SitePageService(context)
+        qry = ServiceOperationQuery(svc, "OrgAssets", None, None, None, return_type)
+        qry.static = True
+        context.add_query(qry)
+        return return_type
+
+    @staticmethod
+    def file_picker_tab_options(context):
+        """
+
+        :param office365.sharepoint.client_context.ClientContext context: Client context
+        """
+        return_type = FilePickerOptions()
+        svc = SitePageService(context)
+        qry = ServiceOperationQuery(svc, "FilePickerTabOptions", None, None, None, return_type)
+        qry.static = True
+        context.add_query(qry)
+        return return_type
+
+    def add_image(self, page_name, image_file_name, image_stream):
+        """
+        Adds an image to the site assets library of the current web.
+        Returns a File object ([MS-CSOMSPT] section 3.2.5.64) that represents the image.
+
+        :param str image_stream: The image stream.
+        :param str image_file_name: Indicates the file name of the image to be added.
+        :param str page_name: Indicates the name of that site page that the image is to be used in.
+        :return: File
+        """
+        return_type = File(self.context)
+        params = {"pageName": page_name, "imageFileName": image_file_name, "imageStream": image_stream}
+        qry = ServiceOperationQuery(self, "AddImage", params, None, None, return_type)
+        qry.static = True
+        self.context.add_query(qry)
+        return return_type
+
+    def update(self):
+        qry = UpdateEntityQuery(self)
+        self.context.add_query(qry)
+        return self
diff --git a/office365/sharepoint/publishing/topic_page_collection.py b/office365/sharepoint/publishing/topic_page_collection.py
@@ -0,0 +1,8 @@
+from office365.runtime.client_object_collection import ClientObjectCollection
+from office365.sharepoint.publishing.topic_site_page import TopicSitePage
+
+
+class TopicPageCollection(ClientObjectCollection):
+
+    def __init__(self, context, resource_path=None):
+        super(TopicPageCollection, self).__init__(context, TopicSitePage, resource_path)
diff --git a/office365/sharepoint/publishing/topic_site_page.py b/office365/sharepoint/publishing/topic_site_page.py
@@ -0,0 +1,7 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class TopicSitePage(BaseEntity):
+
+    def check_out(self):
+        pass
diff --git a/office365/sharepoint/search/query/popularTenantQuery.py b/office365/sharepoint/search/query/popularTenantQuery.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class PopularTenantQuery(ClientValue):
+    pass
diff --git a/office365/sharepoint/search/query/queryAutoCompletionResults.py b/office365/sharepoint/search/query/queryAutoCompletionResults.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class QueryAutoCompletionResults(ClientValue):
+    pass
diff --git a/office365/sharepoint/search/query/tenantCustomQuerySuggestions.py b/office365/sharepoint/search/query/tenantCustomQuerySuggestions.py
@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class TenantCustomQuerySuggestions(ClientValue):
+    pass
diff --git a/office365/sharepoint/search/searchService.py b/office365/sharepoint/search/searchService.py
@@ -1,8 +1,10 @@
 from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.queries.service_operation_query import ServiceOperationQuery
 from office365.runtime.resource_path import ResourcePath
 from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.search.query.popularTenantQuery import PopularTenantQuery
 from office365.sharepoint.search.query.querySuggestionResults import QuerySuggestionResults
 from office365.sharepoint.search.searchResult import SearchResult
 
@@ -32,6 +34,15 @@ def export_manual_suggestions(self):
         """"""
         pass
 
+    def export_popular_tenant_queries(self, count):
+        result = ClientValueCollection(PopularTenantQuery)
+        payload = {
+            "count": count,
+        }
+        qry = ServiceOperationQuery(self, "exportpopulartenantqueries", None, payload, None, result)
+        self.context.add_query(qry)
+        return result
+
     def query(self, search_request):
         """The operation is used to retrieve search results by using the HTTP protocol with the GET method.
 
@@ -85,3 +96,6 @@ def suggest(self, query_text):
         qry = ServiceOperationQuery(self, "suggest", None, payload, None, result)
         self.context.add_query(qry)
         return result
+
+    def auto_completions(self):
+        pass
diff --git a/tests/sharepoint/test_field.py b/tests/sharepoint/test_field.py
@@ -42,8 +42,8 @@ def test_5_update_site_field(self):
         field_to_update.set_property('Title', updated_field_name).update().execute_query()
 
         updated_field = self.client.site.rootWeb.fields.get_by_title(updated_field_name).get().execute_query()
-        self.assertIsNotNone(updated_field.properties['Id'])
-        self.assertEqual(updated_field.properties['Title'], updated_field_name)
+        self.assertIsNotNone(updated_field.id)
+        self.assertEqual(updated_field.title, updated_field_name)
 
     def test_6_delete_site_field(self):
         field_to_delete = self.__class__.target_field
diff --git a/tests/sharepoint/test_publishing.py b/tests/sharepoint/test_publishing.py
@@ -0,0 +1,44 @@
+from office365.sharepoint.publishing.primary_city_time import PrimaryCityTime
+from office365.sharepoint.publishing.site_page_metadata_collection import SitePageMetadataCollection
+from office365.sharepoint.publishing.site_page_service import SitePageService
+from tests.sharepoint.sharepoint_case import SPTestCase
+
+
+class TestSPPublishing(SPTestCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super(TestSPPublishing, cls).setUpClass()
+
+    @classmethod
+    def tearDownClass(cls):
+        pass
+
+    def test1_init_site_page_service(self):
+        svc = SitePageService(self.client).get().execute_query()
+        self.assertIsNotNone(svc.resource_path)
+
+    def test2_get_site_pages(self):
+        svc = SitePageService(self.client)
+        pages = svc.pages().get().execute_query()
+        self.assertIsInstance(pages, SitePageMetadataCollection)
+
+    def test3_get_time_zone(self):
+        time_zone = SitePageService.get_time_zone(self.client, "Moscow").execute_query()
+        self.assertIsInstance(time_zone, PrimaryCityTime)
+        self.assertEqual(time_zone.properties.get("Location"), "Moscow, Russia")
+
+    def test4_compute_file_name(self):
+        result = SitePageService.compute_file_name(self.client, "Test page")
+        self.client.execute_query()
+        self.assertIsNotNone(result.value)
+
+    def test5_file_picker_tab_options(self):
+        result = SitePageService.file_picker_tab_options(self.client)
+        self.client.execute_query()
+        self.assertIsNotNone(result)
+
+    def test6_org_assets(self):
+        result = SitePageService.org_assets(self.client)
+        self.client.execute_query()
+        self.assertIsNotNone(result)
diff --git a/tests/sharepoint/test_search.py b/tests/sharepoint/test_search.py

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +from office365.runtime.client_value import ClientValue
++
++
 +class OrgAssets(ClientValue):
 +    pass