SharePoint API enhancements: portal namespace types & methods

Author: vgrem

examples/sharepoint/lists/enable_doc_id.py

@@ -0,0 +1,7 @@
+from office365.sharepoint.client_context import ClientContext
+from tests import test_client_credentials, test_team_site_url
+
+ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
+
+w = ctx.web.assign_document_id("MEDIADEVDOC").execute_query()
+print("Document IDs has been assigned")

office365/graph_request.py

@@ -0,0 +1,8 @@
+from office365.runtime.odata.request import ODataRequest
+from office365.runtime.odata.v4.json_format import V4JsonFormat
+
+
+class GraphRequest(ODataRequest):
+
+    def __init__(self):
+        super(GraphRequest, self).__init__(V4JsonFormat())

office365/sharepoint/apps/app_collection.py

@@ -0,0 +1,8 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class AppCollection(BaseEntity):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.AppServices.AppCollection"

office365/sharepoint/client_context.py

@@ -3,22 +3,22 @@
 from office365.runtime.auth.authentication_context import AuthenticationContext
 from office365.runtime.auth.user_credential import UserCredential
 from office365.runtime.client_runtime_context import ClientRuntimeContext
+from office365.runtime.compat import urlparse, is_absolute_url, get_absolute_url
 from office365.runtime.http.http_method import HttpMethod
 from office365.runtime.http.request_options import RequestOptions
-from office365.runtime.odata.v3.json_light_format import JsonLightFormat
-from office365.runtime.odata.v3.batch_request import ODataBatchV3Request
 from office365.runtime.odata.request import ODataRequest
+from office365.runtime.odata.v3.batch_request import ODataBatchV3Request
+from office365.runtime.odata.v3.json_light_format import JsonLightFormat
+from office365.runtime.paths.resource_path import ResourcePath
 from office365.runtime.queries.delete_entity import DeleteEntityQuery
 from office365.runtime.queries.update_entity import UpdateEntityQuery
-from office365.runtime.paths.resource_path import ResourcePath
 from office365.sharepoint.portal.sites.status import SiteStatus
 from office365.sharepoint.publishing.pages.service import SitePageService
 from office365.sharepoint.request_user_context import RequestUserContext
 from office365.sharepoint.sites.site import Site
 from office365.sharepoint.tenant.administration.hubsites.collection import HubSiteCollection
 from office365.sharepoint.webs.context_web_information import ContextWebInformation
 from office365.sharepoint.webs.web import Web
-from office365.runtime.compat import urlparse, is_absolute_url, get_absolute_url
 
 
 class ClientContext(ClientRuntimeContext):
@@ -322,6 +322,11 @@ def site(self):
             self._site = Site(self)
         return self._site
 
+    @property
+    def apps(self):
+        from office365.sharepoint.apps.app_collection import AppCollection
+        return AppCollection(self, ResourcePath("Apps"))
+
     @property
     def me(self):
         """Gets the user context for the present request"""
@@ -404,6 +409,18 @@ def machine_learning(self):
         from office365.sharepoint.contentcenter.machinelearning.hub import SPMachineLearningHub
         return SPMachineLearningHub(self, ResourcePath("machinelearning"))
 
+    @property
+    def org_news(self):
+        """Alias to OrgNewsSite"""
+        from office365.sharepoint.portal.organization_news import OrganizationNews
+        return OrganizationNews(self, ResourcePath("OrgNews"))
+
+    @property
+    def org_news_site(self):
+        """Alias to OrgNewsSite"""
+        from office365.sharepoint.orgnewssite.api import OrgNewsSiteApi
+        return OrgNewsSiteApi(self, ResourcePath("OrgNewsSite"))
+
     @property
     def search_setting(self):
         """Alias to SearchSetting"""
@@ -433,6 +450,24 @@ def site_manager(self):
         from office365.sharepoint.portal.sites.manager import SPSiteManager
         return SPSiteManager(self, ResourcePath("spSiteManager"))
 
+    @property
+    def home_service(self):
+        """Alias to SharePointHomeServiceContextBuilder."""
+        from office365.sharepoint.portal.home.service_context_builder import SharePointHomeServiceContextBuilder
+        return SharePointHomeServiceContextBuilder(self, ResourcePath("sphomeservice"))
+
+    @property
+    def home_site(self):
+        """Alias to SPHSite."""
+        from office365.sharepoint.sites.sph_site import SPHSite
+        return SPHSite(self, ResourcePath("SPHSite"))
+
+    @property
+    def publications(self):
+        from office365.sharepoint.base_entity_collection import BaseEntityCollection
+        from office365.sharepoint.contentcenter.machinelearning.publication import SPMachineLearningPublication
+        return BaseEntityCollection(self, SPMachineLearningPublication, ResourcePath("publications"))
+
     @property
     def social_following_manager(self):
         from office365.sharepoint.social.following.manager import SocialFollowingManager
@@ -462,6 +497,12 @@ def tenant_settings(self):
         from office365.sharepoint.tenant.settings import TenantSettings
         return TenantSettings.current(self)
 
+    @property
+    def work_items(self):
+        from office365.sharepoint.contentcenter.machinelearning.work_item_collection import \
+            SPMachineLearningWorkItemCollection
+        return SPMachineLearningWorkItemCollection(self, ResourcePath("workitems"))
+
     @property
     def tenant(self):
         from office365.sharepoint.tenant.administration.tenant import Tenant

office365/sharepoint/contentcenter/machinelearning/publication.py

@@ -2,4 +2,7 @@
 
 
 class SPMachineLearningPublication(BaseEntity):
-    pass
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.Office.Server.ContentCenter.SPMachineLearningPublication"

office365/sharepoint/contentcenter/machinelearning/work_item_collection.py

@@ -0,0 +1,8 @@
+from office365.sharepoint.base_entity_collection import BaseEntityCollection
+from office365.sharepoint.contentcenter.machinelearning.work_item import SPMachineLearningWorkItem
+
+
+class SPMachineLearningWorkItemCollection(BaseEntityCollection):
+
+    def __init__(self, context, resource_path=None):
+        super(SPMachineLearningWorkItemCollection, self).__init__(context, SPMachineLearningWorkItem, resource_path)

office365/sharepoint/listhome/__init__.py

@@ -0,0 +1,8 @@
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class FavoriteLists(BaseEntity):
+
+    @property
+    def entity_type_name(self):
+        return "SP.FavoriteLists"

office365/sharepoint/listhome/favorite_lists.py

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

office365/sharepoint/listhome/item.py

@@ -0,0 +1,23 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.paths.resource_path import ResourcePath
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.orgnewssite.info import OrgNewsSiteInfo
+
+
+class OrgNewsSiteApi(BaseEntity):
+
+    def __init__(self, context, resource_path=None):
+        if resource_path is None:
+            resource_path = ResourcePath("Microsoft.SharePoint.OrgNewsSite.OrgNewsSiteApi")
+        super(OrgNewsSiteApi, self).__init__(context, resource_path)
+
+    def details(self):
+        return_type = ClientResult(self.context, OrgNewsSiteInfo())
+        qry = ServiceOperationQuery(self, "Details", None, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.OrgNewsSite.OrgNewsSiteApi"

office365/sharepoint/orgnewssite/__init__.py

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

office365/sharepoint/orgnewssite/api.py

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

office365/sharepoint/orgnewssite/info.py

@@ -0,0 +1,16 @@
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.base_entity import BaseEntity
+from office365.sharepoint.portal.home.service_context import SharePointHomeServiceContext
+
+
+class SharePointHomeServiceContextBuilder(BaseEntity):
+
+    def get_context(self):
+        return_type = SharePointHomeServiceContext(self.context)
+        qry = ServiceOperationQuery(self, "Context", None, None, None, return_type)
+        self.context.add_query(qry)
+        return None
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Portal.SharePointHomeServiceContextBuilder"

office365/sharepoint/portal/home/page_context.py

@@ -0,0 +1,18 @@
+from office365.runtime.client_result import ClientResult
+from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+from office365.runtime.queries.service_operation import ServiceOperationQuery
+from office365.sharepoint.base_entity import BaseEntity
+
+
+class OrganizationNewsSiteReference(ClientValue):
+    pass
+
+
+class OrganizationNews(BaseEntity):
+
+    def sites_reference(self):
+        return_type = ClientResult(self.context, ClientValueCollection(OrganizationNewsSiteReference))
+        qry = ServiceOperationQuery(self, "SitesReference", None, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type

office365/sharepoint/portal/home/service_context_builder.py

@@ -7,14 +7,16 @@
 
 class SPHSite(BaseEntity):
 
-    def __init__(self, context):
+    def __init__(self, context, resource_path=None):
         """
         A home site represents a SharePoint communication site.
         It brings together news, events, embedded video and conversations, and other resources to deliver an engaging
         experience that reflects your organization's voice, priorities, and brand.
         It also allows your users to search for content (such as sites, news, and files) across your organization
         """
-        super(SPHSite, self).__init__(context, ResourcePath("SP.SPHSite"))
+        if resource_path is None:
+            resource_path = ResourcePath("SP.SPHSite")
+        super(SPHSite, self).__init__(context, resource_path)
 
     def details(self):
         return_type = ClientResult(self.context, SPHSiteReference())

office365/sharepoint/portal/organization_news.py

@@ -1,4 +1,5 @@
 # coding=utf-8
+
 from office365.runtime.client_result import ClientResult
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.queries.service_operation import ServiceOperationQuery
@@ -1279,6 +1280,19 @@ def set_global_nav_settings(self, title, source):
         self.context.add_query(qry)
         return self
 
+    def assign_document_id(self, site_prefix):
+        """
+        Assign Document IDs
+
+        :param str site_prefix: Specify whether IDs will be automatically assigned to all documents in the
+            Site Collection. Additionally, you can specify a set of 4-12 characters that will be used at the beginning
+            of all IDs assigned for documents in this Site Collection, to help ensure that items in different
+            Site Collections will never get the same ID. Note: A timer job will be scheduled to assign IDs to
+            documents already in the Site Collection.
+        """
+        props = {"docid_msft_hier_siteprefix": site_prefix, "docid_enabled": "1"}
+        return self.set_property("AllProperties", props).update()
+
     @property
     def activities(self):
         return self.properties.get("Activities",

office365/sharepoint/sites/sph_site.py

@@ -34,6 +34,10 @@ def test4_is_valid_home_site(self):
         result = self.__class__.target_site.is_valid_home_site().execute_query()
         self.assertIsNotNone(result.value)
 
+    #def test5_get_home_details(self):
+    #    result = self.client.home_site.details().execute_query()
+    #    self.assertIsNotNone(result.value)
+
     def test7_register_hub_site(self):
         tenant = Tenant.from_url(test_admin_site_url).with_credentials(test_user_credentials)
         props = tenant.register_hub_site(self.__class__.target_site.url).execute_query()

office365/sharepoint/webs/web.py

@@ -0,0 +1,12 @@
+from tests.sharepoint.sharepoint_case import SPTestCase
+
+
+class TestOrgNews(SPTestCase):
+
+    def test_1_get_org_news(self):
+        result = self.client.org_news.get().execute_query()
+        self.assertIsNotNone(result.resource_path)
+
+    def test2_sites_reference(self):
+        result = self.client.org_news.sites_reference().execute_query()
+        self.assertIsNotNone(result.value)