publishing namespace enhancements: new types & methods

Author: vgrem

examples/sharepoint/pages/create_modern_page.py

@@ -1,10 +1,13 @@
+import uuid
+
 from office365.sharepoint.client_context import ClientContext
 from office365.sharepoint.publishing.pages.page import SitePage
 from tests import test_client_credentials, test_team_site_url
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
+page_title = "Site Page {0}".format(uuid.uuid4().hex)
 new_page = ctx.site_pages.pages.add()
-new_page.save_draft(title="Latest News 456")
+new_page.save_draft(title=page_title)
 new_page.publish().execute_query()
 
 pages = ctx.site_pages.pages.get().execute_query()

office365/sharepoint/portal/groups/site_manager.py

@@ -16,6 +16,12 @@ def __init__(self, context, resource_path=None):
             resource_path = ResourcePath("GroupSiteManager")
         super(GroupSiteManager, self).__init__(context, resource_path)
 
+    def can_user_create_group(self):
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "CanUserCreateGroup", None, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def create_group_for_site(self, display_name, alias, is_public=None, optional_params=None):
         """
         Create a modern site

office365/sharepoint/publishing/diagnostics/page_diagnostics.py

@@ -1,8 +1,13 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.publishing.diagnostics.page_result import PageDiagnosticsResult
 
 
 class PageDiagnostics(ClientValue):
 
+    def __init__(self, results=None):
+        self.Results = ClientValueCollection(PageDiagnosticsResult, results)
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Publishing.Diagnostics.PageDiagnostics"

office365/sharepoint/publishing/diagnostics/page_result.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class PageDiagnosticsResult(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Publishing.Diagnostics.PageDiagnosticsResult"

office365/sharepoint/publishing/file_picker_options.py

@@ -1,5 +1,14 @@
 from office365.runtime.client_value import ClientValue
+from office365.sharepoint.administration.orgassets.org_assets import OrgAssets
 
 
 class FilePickerOptions(ClientValue):
-    pass
+
+    def __init__(self, search_enabled=None, central_asset_repository=OrgAssets(), org_assets=OrgAssets()):
+        self.BingSearchEnabled = search_enabled
+        self.CentralAssetRepository = central_asset_repository
+        self.OrgAssets = org_assets
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.FilePickerOptions"

office365/sharepoint/publishing/pages/campaign_publication.py

@@ -0,0 +1,8 @@
+from office365.sharepoint.publishing.pages.page import SitePage
+
+
+class CampaignPublication(SitePage):
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.CampaignPublication"

office365/sharepoint/publishing/pages/collection.py

@@ -1,4 +1,5 @@
 from office365.runtime.client_result import ClientResult
+from office365.runtime.paths.service_operation import ServiceOperationPath
 from office365.runtime.queries.create_entity import CreateEntityQuery
 from office365.runtime.queries.service_operation import ServiceOperationQuery
 from office365.runtime.paths.resource_path import ResourcePath
@@ -49,7 +50,7 @@ def is_site_page(self, url):
 
         :param str url: URL of the SitePage to be checked.
         """
-        return_type = ClientResult(self.context)
+        return_type = ClientResult(self.context, bool())
         qry = ServiceOperationQuery(self, "IsSitePage", [url], None, None, return_type)
         self.context.add_query(qry)
         return return_type
@@ -60,7 +61,18 @@ def get_page_column_state(self, url):
 
         :param str url: URL of the SitePage for which to return state.
         """
-        return_type = ClientResult(self.context)
+        return_type = ClientResult(self.context, int())
         qry = ServiceOperationQuery(self, "GetPageColumnState", [url], None, None, return_type)
         self.context.add_query(qry)
         return return_type
+
+    def get_by_url(self, url):
+        """Gets the site page with the specified server relative url.
+
+        :param int url: Specifies the server relative url of the site page.
+        """
+        return SitePage(self.context, ServiceOperationPath("GetByUrl", [url], self.resource_path))
+
+    def templates(self):
+        return SitePageMetadataCollection(self.context, SitePage,
+                                          ServiceOperationPath("Templates", None, self.resource_path))

office365/sharepoint/publishing/pages/page.py

@@ -1,11 +1,24 @@
 from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value import ClientValue
 from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.runtime.types.collections import StringCollection
 from office365.sharepoint.publishing.pages.fields_data import SitePageFieldsData
 from office365.sharepoint.publishing.pages.metadata import SitePageMetadata
 from office365.sharepoint.translation.status_collection import TranslationStatusCollection
 
 
+class SharePagePreviewByEmailFieldsData(ClientValue):
+
+    def __init__(self, message=None, recipient_emails=None):
+        self.message = message
+        self.recipientEmails = StringCollection(recipient_emails)
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.SharePagePreviewByEmailFieldsData"
+
+
 class SitePage(SitePageMetadata):
     """Represents a Site Page."""
 
@@ -28,6 +41,11 @@ def discard_page(self):
         self.context.add_query(qry)
         return self
 
+    def ensure_title_resource(self):
+        qry = ServiceOperationQuery(self, "EnsureTitleResource")
+        self.context.add_query(qry)
+        return self
+
     def save_page(self, title, canvas_content=None, banner_image_url=None, topic_header=None):
         """
         Updates the current Site Page with the provided pageStream content.
@@ -59,10 +77,10 @@ def save_draft(self, title, canvas_content=None, banner_image_url=None, topic_he
                                      canvas_content=canvas_content,
                                      banner_image_url=banner_image_url,
                                      topic_header=topic_header)
-        result = ClientResult(self.context)
-        qry = ServiceOperationQuery(self, "SaveDraft", None, payload, "sitePage", result)
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "SaveDraft", None, payload, "sitePage", return_type)
         self.context.add_query(qry)
-        return result
+        return return_type
 
     def save_page_as_draft(self, title, canvas_content=None, banner_image_url=None, topic_header=None):
         """
@@ -78,10 +96,10 @@ def save_page_as_draft(self, title, canvas_content=None, banner_image_url=None,
                                      canvas_content=canvas_content,
                                      banner_image_url=banner_image_url,
                                      topic_header=topic_header)
-        result = ClientResult(self.context)
-        qry = ServiceOperationQuery(self, "SavePageAsDraft", None, payload, "pageStream", result)
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "SavePageAsDraft", None, payload, "pageStream", return_type)
         self.context.add_query(qry)
-        return result
+        return return_type
 
     def save_page_as_template(self):
         """
@@ -124,7 +142,7 @@ def publish(self):
         Publishes a major version of the current Site Page.  Returns TRUE on success, FALSE otherwise.
 
         """
-        result = ClientResult(self.context)
+        result = ClientResult(self.context, bool())
         qry = ServiceOperationQuery(self, "Publish", None, None, None, result)
         self.context.add_query(qry)
         return result
@@ -146,14 +164,17 @@ def share_page_preview_by_email(self, message, recipient_emails):
         :param str message:
         :param list[str] recipient_emails:
         """
-        payload = {
-            "message": message,
-            "recipientEmails": recipient_emails
-        }
+        payload = SharePagePreviewByEmailFieldsData(message, recipient_emails)
         qry = ServiceOperationQuery(self, "SharePagePreviewByEmail", None, payload)
         self.context.add_query(qry)
         return self
 
+    def start_co_auth(self):
+        return_type = SitePage(self.context, self.resource_path)
+        qry = ServiceOperationQuery(self, "StartCoAuth", None, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def canvas_content(self):
         """

office365/sharepoint/publishing/pages/page_3d.py

@@ -0,0 +1,12 @@
+from office365.sharepoint.publishing.pages.page import SitePage
+
+
+class SitePage3D(SitePage):
+
+    @property
+    def space_content(self):
+        return self.properties.get("SpaceContent", None)
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.SitePage3D"

office365/sharepoint/publishing/pages/service.py

@@ -43,7 +43,7 @@ def can_create_page(self):
         MUST return true if the user has permission to create a site page, otherwise MUST return false.
 
         """
-        return_type = ClientResult(self.context)
+        return_type = ClientResult(self.context, bool())
         qry = ServiceOperationQuery(self, "CanCreatePage", None, None, None, return_type)
         self.context.add_query(qry)
         return return_type
@@ -53,7 +53,7 @@ def can_create_promoted_page(self):
         Checks if the current user has permission to create a site page on the site pages document library.
         MUST return true if the user has permission to create a site page, otherwise MUST return false.
         """
-        return_type = ClientResult(self.context)
+        return_type = ClientResult(self.context, bool())
         qry = ServiceOperationQuery(self, "CanCreatePromotedPage", None, None, None, return_type)
         self.context.add_query(qry)
         return return_type
@@ -82,8 +82,7 @@ def get_time_zone(context, city_name):
         return_type = PrimaryCityTime(context)
         svc = SitePageService(context)
         params = {"cityName": city_name}
-        qry = ServiceOperationQuery(svc, "GetTimeZone", params, None, None, return_type)
-        qry.static = True
+        qry = ServiceOperationQuery(svc, "GetTimeZone", params, None, None, return_type, True)
         context.add_query(qry)
         return return_type
 
@@ -124,12 +123,11 @@ def org_assets(context):
 
         :param office365.sharepoint.client_context.ClientContext context: Client context
         """
-        result = ClientResult(context, OrgAssets())
+        return_type = ClientResult(context, OrgAssets())
         svc = SitePageService(context)
-        qry = ServiceOperationQuery(svc, "OrgAssets", None, None, None, result)
-        qry.static = True
+        qry = ServiceOperationQuery(svc, "OrgAssets", None, None, None, return_type, True)
         context.add_query(qry)
-        return result
+        return return_type
 
     @staticmethod
     def file_picker_tab_options(context):
@@ -155,8 +153,7 @@ def add_image(self, page_name, image_file_name, image_stream):
         """
         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
+        qry = ServiceOperationQuery(self, "AddImage", params, None, None, return_type, True)
         self.context.add_query(qry)
         return return_type
 

office365/sharepoint/search/administration/tenant_crawl_versions_info_provider.py

@@ -3,3 +3,7 @@
 
 class TenantCrawlVersionsInfoProvider(BaseEntity):
     """"""
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Client.Search.Administration.TenantCrawlVersionsInfoProvider"

office365/sharepoint/search/query/auto_completion.py

@@ -1,4 +1,6 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.sharepoint.search.query.auto_completion_match import QueryAutoCompletionMatch
 
 
 class QueryAutoCompletion(ClientValue):
@@ -12,6 +14,7 @@ def __init__(self, query=None, score=None, source=None):
              Source.
         :param str source: This element represents the Source used when retrieving the matched results.
         """
+        self.Matches = ClientValueCollection(QueryAutoCompletionMatch)
         self.Query = query
         self.Score = score
         self.Source = source

tests/sharepoint/test_publishing.py

@@ -1,6 +1,6 @@
 from office365.sharepoint.publishing.pages.collection import SitePageCollection
-from office365.sharepoint.publishing.pages.service import SitePageService
 from office365.sharepoint.publishing.pages.page import SitePage
+from office365.sharepoint.publishing.pages.service import SitePageService
 from office365.sharepoint.publishing.video.service_discoverer import VideoServiceDiscoverer
 from tests.sharepoint.sharepoint_case import SPTestCase
 
@@ -16,12 +16,11 @@ def tearDownClass(cls):
         pass
 
     def test1_init_site_page_service(self):
-        svc = SitePageService(self.client).get().execute_query()
+        svc = self.client.site_pages.get().execute_query()
         self.assertIsNotNone(svc.resource_path)
 
     def test2_get_site_pages(self):
-        svc = SitePageService(self.client)
-        pages = svc.pages.get().execute_query()
+        pages = self.client.site_pages.pages.get().execute_query()
         self.assertIsInstance(pages, SitePageCollection)
 
     # def test3_get_time_zone(self):
@@ -64,3 +63,7 @@ def test_11_get_page_diagnostics(self):
         result = self.client.page_diagnostics.by_page("/sites/team/SitePages/Home.aspx").execute_query()
         self.assertIsNotNone(result.value)
 
+    #def test_12_share_page_preview_by_email(self):
+    #    page = self.client.site_pages.pages.get_by_url("/sites/team/SitePages/Home.aspx")
+    #    page.share_page_preview_by_email("This page has been shared with you",
+    #                                     [test_user_principal_name_alt]).execute_query()

tests/sharepoint/test_search.py

@@ -45,7 +45,7 @@ def test6_search_suggest(self):
         result = self.client.search.suggest("guide.docx").execute_query()
         self.assertIsInstance(result.value, QuerySuggestionResults)
 
-    #def test7_auto_completions(self):
+    # def test7_auto_completions(self):
     #    result = self.search.auto_completions("guide").execute_query()
     #    self.assertIsNotNone(result.value)
 
@@ -56,9 +56,16 @@ def test8_get_query_configuration(self):
     def test9_get_promoted_result_query_rules(self):
         result = self.client.search_setting.get_promoted_result_query_rules().execute_query()
         self.assertIsNotNone(result.value)
-        
 
-    #def test7_get_crawled_urls(self):
+    # def test7_get_crawled_urls(self):
     #    doc_crawl_log = DocumentCrawlLog(self.client)
     #    result = doc_crawl_log.get_crawled_urls().execute_query()
     #    self.assertIsNotNone(result.value)
+
+    #def test_10_auto_completions(self):
+    #    result = self.client.search.auto_completions("guide.docx").execute_query()
+    #    self.assertIsNotNone(result.value)
+
+    #def test_11_get_crawled_urls(self):
+    #    result = DocumentCrawlLog(self.client).get_crawled_urls().execute_query()
+    #    self.assertIsNotNone(result.value)

tests/sharepoint/test_team_site.py

@@ -16,19 +16,23 @@ def setUpClass(cls):
         client = ClientContext(test_site_url).with_credentials(test_user_credentials)
         cls.client = client
 
-    def test1_create_site(self):
+    def test1_can_user_create_group(self):
+        result = self.client.group_site_manager.can_user_create_group().execute_query()
+        self.assertIsNotNone(result.value)
+
+    def test2_create_site(self):
         site_name = "TeamSite{0}".format(uuid.uuid4().hex)
         site = self.client.create_team_site(site_name, "Team Site", True).execute_query()
         self.assertIsNotNone(site.url)
         self.__class__.target_site = site
 
-    def test2_get_site_status(self):
+    def test3_get_site_status(self):
         site = self.__class__.target_site.get().select(["GroupId"]).execute_query()
         result = self.client.group_site_manager.get_status(site.group_id).execute_query()
         self.assertIsNotNone(result.value.SiteStatus)
         self.assertTrue(result.value.SiteStatus == SiteStatus.Ready)
 
-    def test3_get_notebook_url(self):
+    def test4_get_notebook_url(self):
         group_id = self.__class__.target_site.group_id
         result = self.client.group_site_manager.notebook(group_id).execute_query()
         self.assertIsNotNone(result.value)