SharePoint API: view namespace updates

Author: vgrem

examples/sharepoint/files/get_file_properties.py

@@ -5,14 +5,24 @@
 
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
 file_url = '/sites/team/Shared Documents/big_buck_bunny.mp4'
-#file = ctx.web.get_file_by_server_relative_url(file_url).get().execute_query()
-file = ctx.web.get_file_by_server_relative_url(file_url).expand(["ModifiedBy"]).get().execute_query()
+file = ctx.web.get_file_by_server_relative_url(file_url).get().execute_query()
+#file = ctx.web.get_file_by_server_relative_url(file_url).expand(["ModifiedBy"]).get().execute_query()
+#file = ctx.web.get_file_by_server_relative_url(file_url).expand(["ListItemAllFields"]).get().execute_query()
 
 # print all file properties
 #print(json.dumps(file.properties, indent=4))
 
 # or directly via object properties
 print("File size: ", file.length)
 print("File name: ", file.name)
-print("File modified by: {0}".format(file.modified_by.properties.get('UserPrincipalName')))
+#print("File modified by: {0}".format(file.modified_by.properties.get('UserPrincipalName')))
+#print("File modified by: {0}".format(file.listItemAllFields))
+if file.properties.get('CheckOutType') == 0:
+    print("The file is checked out for editing on the server")
+elif file.properties.get('CheckOutType') == 1:
+    print("The file is checked out for editing on the local computer.")
+else:
+    print("The file is not checked out.")
+
+
 

examples/sharepoint/views/read_items.py

@@ -1,7 +1,28 @@
 from office365.sharepoint.client_context import ClientContext
+from office365.sharepoint.listitems.listitem import ListItem
 from tests import test_client_credentials, test_team_site_url
 
+
+def retrieve_default_view_items(context):
+    """
+    :type context: ClientContext
+    """
+    lib = context.web.default_document_library()
+    items = lib.default_view.get_items().execute_query()
+    for item in items:  # type: ListItem
+        print(item.id)
+
+
+def retrieve_custom_view_items(context):
+    """
+    :type context: ClientContext
+    """
+    view = context.web.lists.get_by_title("Contacts_Large").views.get_by_title("All contacts")
+    items = view.get_items().top(5).execute_query()
+    for item in items:  # type: ListItem
+        print(item.id)
+
+
 ctx = ClientContext(test_team_site_url).with_credentials(test_client_credentials)
-lib = ctx.web.default_document_library()
-items = lib.default_view.get_items().execute_query()
-print(items)
+retrieve_default_view_items(ctx)
+#retrieve_custom_view_items(ctx)

office365/sharepoint/listitems/caml/query.py

@@ -2,15 +2,77 @@
 from office365.sharepoint.views.scope import ViewScope
 
 
+class WhereElement(object):
+    """Used within the context of a query to specify a filter."""
+
+    def __str__(self):
+        return "<Where></Where>"
+
+
+class OrderByElement(object):
+    """Determines the sort order for a query"""
+
+    def __str__(self):
+        return "<OrderBy></OrderBy>"
+
+
+class GroupByElement(object):
+    """Contains a Group By section for grouping the data returned through a query in a list view."""
+
+    def __str__(self):
+        return "<GroupBy></GroupBy>"
+
+
+class QueryElement(object):
+    """Defines the query for a view."""
+
+    def __init__(self):
+        self.Where = WhereElement()
+        self.OrderBy = OrderByElement()
+        self.GroupBy = GroupByElement()
+
+    @staticmethod
+    def parse(expr):
+        return QueryElement()
+
+    def __repr__(self):
+        return "<Query>{0}</Query>".format(str(self.Where))
+
+
+class RowLimitElement(object):
+    """Sets the row limit for the number of items to display in a view."""
+
+    def __init__(self, top=None):
+        """
+        :param int top:
+        """
+        self.Top = top
+
+    def __str__(self):
+        return "<RowLimit Paged=\"TRUE\">{0}</RowLimit>".format(self.Top)
+
+
+class ViewElement(object):
+    """"""
+
+    def __init__(self, scope=ViewScope.DefaultValue, query=QueryElement(), row_limit=RowLimitElement()):
+        self.Scope = scope
+        self.Query = query
+        self.RowLimit = row_limit
+
+    def __str__(self):
+        return "<View Scope=\"{0}\"><Query>{1}</Query></View>".format(self.Scope, str(self.Query))
+
+
 class CamlQuery(ClientValue):
 
-    def __init__(self, dates_in_utc=True, view_xml=None, listitem_collection_position=None,
+    def __init__(self, dates_in_utc=True, view_xml=None, list_item_collection_position=None,
                  folder_server_relative_url=None, allow_incremental_results=True):
         """
         Specifies a Collaborative Application Markup Language (CAML) query on a list or joined lists.
 
         :type bool allowIncrementalResults: Specifies whether the incremental results can be returned.
-        :param ListItemCollectionPosition listitem_collection_position: Specifies the information required to
+        :param ListItemCollectionPosition list_item_collection_position: Specifies the information required to
             get the next page of data for the list view.
         :param str view_xml: Specifies the XML schema that defines the list view.
         :param str or None folder_server_relative_url: Specifies the server-relative URL of a list folder from which
@@ -22,26 +84,20 @@ def __init__(self, dates_in_utc=True, view_xml=None, listitem_collection_positio
         self.FolderServerRelativeUrl = folder_server_relative_url
         self.AllowIncrementalResults = allow_incremental_results
         self.ViewXml = view_xml
-        self.ListItemCollectionPosition = listitem_collection_position
+        self.ListItemCollectionPosition = list_item_collection_position
 
     @staticmethod
     def parse(query_expr, scope=ViewScope.DefaultValue):
         """
-        Initiates a CamlQuery object from a query expression
+        Creates a CamlQuery object from a query expression
 
-        :type query_expr: str
-        :type scope: ViewScope
+        :param str query_expr: Defines the query for a view.
+        :param ViewScope scope: Specifies whether and how files and subfolders are included in a view.
         """
         qry = CamlQuery()
         qry.ViewXml = "<View Scope=\"{0}\"><Query>{1}</Query></View>".format(scope, query_expr)
         return qry
 
-    @staticmethod
-    def create_custom_query(query):
-        qry = CamlQuery()
-        qry.ViewXml = query
-        return qry
-
     @staticmethod
     def create_all_items_query():
         return CamlQuery.parse("", ViewScope.RecursiveAll)
@@ -58,6 +114,9 @@ def create_all_files_query():
         qry_text = "<Where><Eq><FieldRef Name=\"FSObjType\" /><Value Type=\"Integer\">0</Value></Eq></Where>"
         return CamlQuery.parse(qry_text, ViewScope.RecursiveAll)
 
+    def __repr__(self):
+        return self.ViewXml
+
     @property
     def entity_type_name(self):
         return 'SP.CamlQuery'

office365/sharepoint/publishing/pages/service.py

@@ -112,11 +112,11 @@ def is_file_picker_external_image_search_enabled(context):
 
         :param office365.sharepoint.client_context.ClientContext context: Client context
         """
-        result = ClientResult(context)
+        return_type = ClientResult(context)
         svc = SitePageService(context)
-        qry = ServiceOperationQuery(svc, "IsFilePickerExternalImageSearchEnabled", None, None, None, result, True)
+        qry = ServiceOperationQuery(svc, "IsFilePickerExternalImageSearchEnabled", None, None, None, return_type, True)
         context.add_query(qry)
-        return result
+        return return_type
 
     @staticmethod
     def org_assets(context):

office365/sharepoint/publishing/portallaunch/__init__.py

@@ -0,0 +1,8 @@
+from office365.runtime.client_value import ClientValue
+
+
+class PortalLaunchWave(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.PortalLaunch.PortalLaunchWave"

office365/sharepoint/publishing/portallaunch/wave.py

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

office365/sharepoint/publishing/portallaunch/waves_manager.py

@@ -0,0 +1,5 @@
+from office365.runtime.client_value import ClientValue
+
+
+class ProvisionedTemporaryAzureContainerInfo(ClientValue):
+    pass

office365/sharepoint/sites/azure_container_Info.py

@@ -15,6 +15,7 @@
 from office365.sharepoint.recyclebin.item_collection import RecycleBinItemCollection
 from office365.sharepoint.sitehealth.summary import SiteHealthSummary
 from office365.sharepoint.sites.sph_site import SPHSite
+from office365.sharepoint.sites.azure_container_Info import ProvisionedTemporaryAzureContainerInfo
 from office365.sharepoint.sites.upgrade_info import UpgradeInfo
 from office365.sharepoint.sites.usage_info import UsageInfo
 from office365.sharepoint.tenant.administration.site_administrators_info import SiteAdministratorsInfo
@@ -319,6 +320,13 @@ def open_web_by_id(self, web_id):
         self.context.add_query(qry)
         return return_type
 
+    def provision_temporary_azure_container(self):
+        """"""
+        return_type = ClientResult(self.context, ProvisionedTemporaryAzureContainerInfo())
+        qry = ServiceOperationQuery(self, "ProvisionTemporaryAzureContainer", None, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     def register_hub_site(self, create_info=None):
         """Registers an existing site as a hub site.
 

office365/sharepoint/sites/site.py

@@ -1,8 +1,24 @@
 from office365.runtime.client_value import ClientValue
+from office365.runtime.client_value_collection import ClientValueCollection
+
+
+class CollaborativeUsers(ClientValue):
+
+    @property
+    def entity_type_name(self):
+        return "Microsoft.SharePoint.Administration.TenantAdmin.CollaborativeUsers"
 
 
 class CollaborationInsightsData(ClientValue):
 
+    def __init__(self, last_report_date=None, collaborative_users=None):
+        """
+        :param str last_report_date:
+        :param list[CollaborativeUsers] collaborative_users:
+        """
+        self.collaborativeUsers = ClientValueCollection(CollaborativeUsers, collaborative_users)
+        self.lastReportDate = last_report_date
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Administration.TenantAdmin.CollaborationInsightsData"