Office365-REST-Python-Client 2.4.2__py3-none-any.whl → 2.4.4__py3-none-any.whl

office365/sharepoint/navigation/metadata_settings.py

@@ -5,23 +5,25 @@ from office365.sharepoint.navigation.configured_metadata_items import Configured
 
 
 class MetadataNavigationSettings(BaseEntity):
-
+    """Described and allows changes to the meta-data navigation and filtering settings on an SPList."""
 
     @staticmethod
-    def get_configured_settings(context, url):
+    def get_configured_settings(context, url, return_type=None):
         """
         Retrieves the configured metadata navigation settings for the list with the specified url.
 
 
         :param office365.sharepoint.client_context.ClientContext context: SharePoint context
         :param str url: Specifies list url
+        :param ClientResult return_type: Return type
         """
 
-        return_type = ClientResult(context, ConfiguredMetadataNavigationItemCollection())
+        if return_type is None:
+            return_type = ClientResult(context, ConfiguredMetadataNavigationItemCollection())
         payload = {
             "DecodedUrl": url
         }
-        qry = ServiceOperationQuery(MetadataNavigationSettings(context), "GetConfiguredSettings", None, payload,
+        qry = ServiceOperationQuery(MetadataNavigationSettings(context), "GetConfiguredSettings", payload, None,
                                     None, return_type, True)
         context.add_query(qry)
         return return_type

office365/sharepoint/permissions/irm/file_settings.py

@@ -10,3 +10,46 @@ class InformationRightsManagementFileSettings(BaseEntity):
         qry = ServiceOperationQuery(self, "Reset")
         self.context.add_query(qry)
         return self
+
+    @property
+    def allow_print(self):
+        """
+        Gets a value indicating whether or not the user can print the downloaded document.
+        True if print is allowed; otherwise, it is false. The default value is false.
+        :rtype: bool
+        """
+        return self.properties.get("AllowPrint", None)
+
+    @allow_print.setter
+    def allow_print(self, value):
+        """
+         Sets a value indicating whether or not the user can print the downloaded document.
+        :param bool value:
+        """
+        self.set_property("AllowPrint", value)
+
+    @property
+    def allow_script(self):
+        """
+        Gets a value indicating whether or not the user can run a script on the downloaded document.
+        True if the script is allowed to run; otherwise, it is false. The default value is false.
+        :rtype: bool
+        """
+        return self.properties.get("AllowScript", None)
+
+    @allow_script.setter
+    def allow_script(self, value):
+        """
+        Sets a value indicating whether or not the user can run a script on the downloaded document.
+        :param bool value:
+        """
+        self.set_property("AllowPrint", value)
+
+    @property
+    def allow_write_copy(self):
+        """
+        Getsa value indicating whether or not the user can write on a copy of the downloaded document.
+        True if write on a copy is allowed; otherwise, it is false. The default value is false.
+        :rtype: bool
+        """
+        return self.properties.get("AllowWriteCopy", None)

office365/sharepoint/permissions/securable_object.py

@@ -107,20 +107,19 @@ class SecurableObject(BaseEntity):
         """
         return_type = ClientResult(self.context, BasePermissions())
 
-        def _create_query(login_name):
+        def _create_and_add_query(login_name):
             """
             :param str login_name:
             """
-            return ServiceOperationQuery(self, "GetUserEffectivePermissions", [login_name], None, None, return_type)
+            qry = ServiceOperationQuery(self, "GetUserEffectivePermissions", [login_name], None, None, return_type)
+            self.context.add_query(qry)
 
         if isinstance(user, User):
             def _user_loaded():
-                next_qry = _create_query(user.login_name)
-                self.context.add_query(next_qry)
+                _create_and_add_query(user.login_name)
             user.ensure_property("LoginName", _user_loaded)
         else:
-            qry = _create_query(user)
-            self.context.add_query(qry)
+            _create_and_add_query(user)
         return return_type
 
     @property

office365/sharepoint/portal/sites/manager.py

@@ -29,20 +29,19 @@ class SPSiteManager(BaseEntity):
         """
         return_type = ClientResult(self.context, SPSiteCreationResponse())
 
-        def _create_query(owner_string=None):
+        def _create(owner_string=None):
             request = SPSiteCreationRequest(title, site_url, owner_string)
             payload = {"request": request}
-            return ServiceOperationQuery(self, "Create", None, payload, None, return_type)
+            qry = ServiceOperationQuery(self, "Create", None, payload, None, return_type)
+            self.context.add_query(qry)
 
         from office365.sharepoint.principal.users.user import User
         if isinstance(owner, User):
             def _owner_loaded():
-                next_qry = _create_query(owner.user_principal_name)
-                self.context.add_query(next_qry)
+                _create(owner.user_principal_name)
             owner.ensure_property("UserPrincipalName", _owner_loaded)
         else:
-            qry = _create_query(owner)
-            self.context.add_query(qry)
+            _create(owner)
         return return_type
 
     def delete(self, site_id):

office365/sharepoint/portal/userprofiles/documents_shared_with_group.py

@@ -2,6 +2,9 @@ from office365.sharepoint.base_entity import BaseEntity
 
 
 class DocumentsSharedWithGroup(BaseEntity):
+    """
+    Provides methods for working with a list that shares documents with a SharePoint Group on the user's personal site.
+    """
 
     @property
     def entity_type_name(self):

office365/sharepoint/publishing/base_custom_property.py

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

office365/sharepoint/publishing/navigation/structural_navigation_cache_wrapper.py

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

office365/sharepoint/publishing/pagecopywithassets/response.py

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

office365/sharepoint/publishing/pages/campaign_publication.py

@@ -13,6 +13,13 @@ class CampaignPublication(SitePage):
         self.context.add_query(qry)
         return return_type
 
+    @property
+    def email_endpoint(self):
+        """
+        :rtype: str
+        """
+        return self.properties.get("EmailEndpoint", None)
+
     @property
     def entity_type_name(self):
         return "SP.Publishing.CampaignPublication"

office365/sharepoint/publishing/pages/collection.py

@@ -80,7 +80,7 @@ class SitePageCollection(SitePageMetadataCollection):
 
         :rtype: SitePage
         """
-        return self.filter("FileName eq '{0}'".format(name)).single()
+        return self.single("FileName eq '{0}'".format(name))
 
     def templates(self):
         return SitePageMetadataCollection(self.context, SitePage,

office365/sharepoint/publishing/pages/page.py

@@ -11,6 +11,10 @@ from office365.sharepoint.translation.status_collection import TranslationStatus
 class SharePagePreviewByEmailFieldsData(ClientValue):
 
     def __init__(self, message=None, recipient_emails=None):
+        """
+        :param str message:
+        :param list[str] recipient_emails:
+        """
         self.message = message
         self.recipientEmails = StringCollection(recipient_emails)
 
@@ -150,7 +154,6 @@ class SitePage(SitePageMetadata):
     def schedule_publish(self, publish_start_date):
         """
         Schedules the page publication for a certain date
-
         :param datetime.datetime publish_start_date: The pending publication scheduled date
         """
         payload = SitePageFieldsData(publish_start_date=publish_start_date)

office365/sharepoint/publishing/pages/reposts/metadata.py

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

office365/sharepoint/publishing/personmagazine/person_magazine.py

@@ -2,4 +2,7 @@ from office365.sharepoint.base_entity import BaseEntity
 
 
 class PersonMagazine(BaseEntity):
-    pass
+
+    @property
+    def entity_type_name(self):
+        return "SP.Publishing.PersonMagazine"

office365/sharepoint/search/administration/tenant_crawl_versions_info_provider.py

@@ -20,7 +20,6 @@ class TenantCrawlVersionsInfoProvider(BaseEntity):
         self.context.add_query(qry)
         return return_type
 
-
     def is_crawl_versions_enabled(self, site_id):
         """
         :param str site_id:
@@ -33,6 +32,14 @@ class TenantCrawlVersionsInfoProvider(BaseEntity):
         self.context.add_query(qry)
         return return_type
 
+    def is_crawl_versions_enabled_for_tenant(self):
+        """
+        """
+        return_type = ClientResult(self.context, bool())
+        qry = ServiceOperationQuery(self, "IsCrawlVersionsEnabledForTenant", None, None, None, return_type)
+        self.context.add_query(qry)
+        return return_type
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Client.Search.Administration.TenantCrawlVersionsInfoProvider"

office365/sharepoint/search/query/auto_completion_match.py

@@ -5,6 +5,9 @@ class QueryAutoCompletionMatch(ClientValue):
     """Represents one match in the Source for the Query"""
 
     def __init__(self, alternation=None, key=None):
+        """
+
+        """
         self.Alternation = alternation
         self.Key = key
 

office365/sharepoint/search/query/property_value.py

@@ -5,6 +5,24 @@ class QueryPropertyValue(ClientValue):
     """This object is used to store values of predefined types. The object MUST have a value set for only
     one of the property."""
 
+    def __init__(self, bool_val=None, int_val=None, str_array=None, str_val=None, query_property_value_type_index=None):
+        """
+        :param bool bool_val: Specifies any arbitrary value of type CSOM Boolean. This property MUST have a value only
+            if QueryPropertyValueTypeIndex is set to 3.
+        :param int int_val: Specifies any arbitrary value of type CSOM Int32. This property MUST have a value only
+            if QueryPropertyValueTypeIndex is set to 2.
+        :param int query_property_value_type_index: Specifies the type of data stored in this object.
+        :param list[str] str_array: Specifies any arbitrary value of type CSOM array. This property MUST have a
+             value only if QueryPropertyValueTypeIndex is set to 4.
+        :param str str_val: Specifies any arbitrary value of type CSOM String. This property MUST have a value
+             only if QueryPropertyValueTypeIndex is set to 1.
+        """
+        self.BoolVal = bool_val
+        self.IntVal = int_val
+        self.StrArray = str_array
+        self.StrVal = str_val
+        self.QueryPropertyValueTypeIndex = query_property_value_type_index
+
     @property
     def entity_type_name(self):
         return "Microsoft.SharePoint.Client.Search.Query.QueryPropertyValue"

office365/sharepoint/search/request.py

@@ -1,6 +1,7 @@
 from office365.runtime.client_value import ClientValue
 from office365.runtime.client_value_collection import ClientValueCollection
 from office365.runtime.types.collections import StringCollection
+from office365.sharepoint.search.query.property import QueryProperty
 from office365.sharepoint.search.query.reordering_rule import ReorderingRule
 from office365.sharepoint.search.query.sort.sort import Sort
 
@@ -17,7 +18,9 @@ class SearchRequest(ClientValue):
                  row_limit=None, rows_per_page=None, start_row=None,
                  enable_sorting=None, sort_list=None, query_template=None, ranking_model_id=None,
                  summary_length=None, collapse_specification=None, client_type=None,
-                 enable_query_rules=None, source_id=None, reordering_rules=None, **kwargs):
+                 enable_query_rules=None, source_id=None, reordering_rules=None,
+                 properties=None, ui_language=None, hit_highlighted_properties=None,
+                 hit_highlighted_multivalue_property_limit=None, **kwargs):
         """
         :param str query_text: The query text of the search query. If this element is not present or a value is not
             specified, a default value of an empty string MUST be used, and the server MUST return a
@@ -66,7 +69,14 @@ class SearchRequest(ClientValue):
         :param str or None source_id: Specifies the unique identifier for result source to use for executing the
             search query. If no value is specified then the protocol server MUST use the id for the default
             result source.
-        :param [ReorderingRule] reordering_rules:
+        :param list[ReorderingRule] reordering_rules: Specifies the list of rules used to reorder search results.
+        :param list[QueryProperty] properties: Used to transport additional and custom search query data, in a
+             name-value structure, from the caller to the server.
+        :param int ui_language: Specifies the LCID for UI culture.
+        :param list[str] hit_highlighted_properties: A list of properties that the protocol server includes in the
+             HitHighlightedProperties for each result
+        :param int hit_highlighted_multivalue_property_limit: Specifies the maximum number of hit highlighted values
+             of multi-value properties to be returned.
         """
         super(SearchRequest, self).__init__()
         self.Querytext = query_text
@@ -86,6 +96,10 @@ class SearchRequest(ClientValue):
         self.EnableQueryRules = enable_query_rules
         self.SourceId = source_id
         self.ReorderingRules = ClientValueCollection(ReorderingRule, reordering_rules)
+        self.Properties = ClientValueCollection(QueryProperty, properties)
+        self.UILanguage = ui_language
+        self.HitHighlightedProperties = StringCollection(hit_highlighted_properties)
+        self.HitHighlightedMultivaluePropertyLimit = hit_highlighted_multivalue_property_limit
         self.__dict__.update(**kwargs)
 
     @property

office365/sharepoint/sharing/abilities.py

@@ -1,4 +1,6 @@
 from office365.runtime.client_value import ClientValue
+from office365.sharepoint.sharing.direct_abilities import DirectSharingAbilities
+from office365.sharepoint.sharing.link_abilities import SharingLinkAbilities
 
 
 class SharingAbilities(ClientValue):
@@ -7,6 +9,26 @@ class SharingAbilities(ClientValue):
     with the state of each capability for the current user.
     """
 
+    def __init__(self, anonymous_link_abilities=SharingLinkAbilities(),
+                 anyone_link_abilities=SharingLinkAbilities(),
+                 direct_sharing_abilities=DirectSharingAbilities(),
+                 organization_link_abilities=SharingLinkAbilities(),
+                 people_sharing_link_abilities=SharingLinkAbilities()):
+        """
+        :param SharingLinkAbilities anonymous_link_abilities: Indicates abilities for anonymous access links.
+        :param SharingLinkAbilities anonymous_link_abilities:
+        :param DirectSharingAbilities direct_sharing_abilities: Indicates abilities for direct sharing of a document
+            using the canonical URL.
+        :param SharingLinkAbilities organization_link_abilities: Indicates abilities for organization access links.
+        :param SharingLinkAbilities people_sharing_link_abilities: Indicates abilities for tokenized sharing links that
+            are configured to support only a predefined restricted membership set.
+        """
+        self.anonymousLinkAbilities = anonymous_link_abilities
+        self.anyoneLinkAbilities = anyone_link_abilities
+        self.directSharingAbilities = direct_sharing_abilities
+        self.organizationLinkAbilities = organization_link_abilities
+        self.peopleSharingLinkAbilities = people_sharing_link_abilities
+
     @property
     def entity_type_name(self):
         return "SP.Sharing.SharingAbilities"

office365/sharepoint/sharing/direct_abilities.py

@@ -0,0 +1,27 @@
+from office365.runtime.client_value import ClientValue
+from office365.sharepoint.sharing.ability_status import SharingAbilityStatus
+
+
+class DirectSharingAbilities(ClientValue):
+    """Represents the set of capabilities for direct sharing for the current user."""
+
+    def __init__(self, can_add_external_principal=SharingAbilityStatus(),
+                 can_add_internal_principal=SharingAbilityStatus(),
+                 can_request_grant_access=SharingAbilityStatus(),
+                 supports_review_permission=SharingAbilityStatus()):
+        """
+        :param SharingAbilityStatus can_add_external_principal: Indicates whether the current user can share to new
+            external users.
+        :param SharingAbilityStatus can_add_internal_principal: Indicates whether the current user can share to
+            internal users.
+        :param SharingAbilityStatus can_request_grant_access: Indicates whether the current user can initiate a
+            request for someone with higher permissions to grant access.
+        """
+        self.canAddExternalPrincipal = can_add_external_principal
+        self.canAddInternalPrincipal = can_add_internal_principal
+        self.canRequestGrantAccess = can_request_grant_access
+        self.supportsReviewPermission = supports_review_permission
+
+    @property
+    def entity_type_name(self):
+        return "SP.Sharing.DirectSharingAbilities"

office365/sharepoint/sharing/link_abilities.py

@@ -10,14 +10,22 @@ class SharingLinkAbilities(ClientValue):
 
     def __init__(self, can_add_new_external_principals=SharingAbilityStatus(),
                  can_delete_edit_link=SharingAbilityStatus(),
-                 can_delete_manage_list_link=SharingAbilityStatus()):
+                 can_delete_manage_list_link=SharingAbilityStatus(),
+                 can_get_edit_link=SharingAbilityStatus(),
+                 can_get_read_link=SharingAbilityStatus()):
         """
         :param SharingAbilityStatus can_add_new_external_principals:
         :param SharingAbilityStatus can_delete_edit_link:
+        :param SharingAbilityStatus can_get_edit_link: Indicates whether the current user can get an existing tokenized
+            sharing link that provides edit access.
+        :param SharingAbilityStatus can_get_read_link: Indicates whether the current user can get an existing tokenized
+            sharing link that provides read access.
         """
         self.canAddNewExternalPrincipals = can_add_new_external_principals
         self.canDeleteEditLink = can_delete_edit_link
         self.canDeleteManageListLink = can_delete_manage_list_link
+        self.canGetEditLink = can_get_edit_link
+        self.canGetReadLink = can_get_read_link
 
     @property
     def entity_type_name(self):

office365/sharepoint/sharing/links/data.py

@@ -7,4 +7,29 @@ class SharingLinkData(ClientValue):
     about the object the link URL refers to and any additional sharing link data if the link URL
     is a tokenized sharing link.
     """
-    pass
+
+    def __init__(self, blocks_download=None, description=None, embeddable=None, expiration=None,
+                 has_external_guest_invitees=None, is_anonymous=None, is_create_only_link=None,
+                 is_forms_link=None):
+        """
+        :param bool blocks_download:
+        :param str description:
+        :param bool embeddable:
+        :param str expiration: The UTC date/time string with complete representation for calendar date and time of
+           day which represents the time and date of expiry for the tokenized sharing link
+           (i.e. is not accessible anymore)
+        :param bool has_external_guest_invitees: Boolean indicating whether the link URL is a tokenized sharing link
+            that has any external guest invitees (external users explicitly invited by email address).
+        :param bool is_anonymous: Boolean indicating if the link is anonymously accessible.
+        :param bool is_create_only_link:
+        :param bool is_forms_link: Indicates if the link URL is a tokenized sharing link that supports forms sharing.
+            This is limited to only tokenized sharing links generated with the Excel Survey feature.
+        """
+        self.BlocksDownload = blocks_download
+        self.Description = description
+        self.Embeddable = embeddable
+        self.Expiration = expiration
+        self.HasExternalGuestInvitees = has_external_guest_invitees
+        self.IsAnonymous = is_anonymous
+        self.IsCreateOnlyLink = is_create_only_link
+        self.IsFormsLink = is_forms_link

office365/sharepoint/sharing/links/info.py

@@ -43,7 +43,7 @@ class SharingLinkInfo(ClientValue):
         return self.Url
 
     def __repr__(self):
-        return self.Url
+        return self.Url or ""
 
     @property
     def entity_type_name(self):

office365/sharepoint/sharing/links/partial_success_response.py

@@ -0,0 +1,5 @@
+from office365.sharepoint.sharing.links.share_response import ShareLinkResponse
+
+
+class ShareLinkPartialSuccessResponse(ShareLinkResponse):
+    """"""

office365/sharepoint/sharing/links/share_settings.py

@@ -4,13 +4,36 @@ from office365.runtime.client_value import ClientValue
 class ShareLinkSettings(ClientValue):
     """Represents the settings the retrieval or creation/update of a tokenized sharing link"""
 
-    def __init__(self, link_kind, expiration=None):
+    def __init__(self, allow_anonymous_access=None, application_link=None, link_kind=None, expiration=None,
+                 password=None, password_protected=None, role=None,
+                 track_link_users=None, share_id=None):
         """
+        :param bool allow_anonymous_access: Indicates if the tokenized sharing link supports anonymous access.
+             This value is optional and defaults to false for Flexible links (section 3.2.5.315.1.7) and is ignored
+             for other link kinds.
+        :param bool application_link:
         :param int link_kind: The kind of the tokenized sharing link to be created/updated or retrieved.
             This value MUST NOT be set to Uninitialized (section 3.2.5.315.1.1) nor Direct (section 3.2.5.315.1.2)
+        :param str password: Optional password value to apply to the tokenized sharing link, if it can support password
+            protection. If this value is null or empty when the updatePassword parameter is set, any existing password
+            on the tokenized sharing link MUST be cleared. Any other value will be applied to the tokenized sharing link
+            as a password setting.
+        :param bool password_protected:
+        :param int role: The role to be used for the tokenized sharing link. This is required for Flexible links
+            and ignored for all other kinds.
+        :param bool track_link_users:
+        :param str share_id: The optional unique identifier of an existing section tokenized sharing link to be
+             retrieved and updated if necessary.
         """
+        self.allowAnonymousAccess = allow_anonymous_access
+        self.applicationLink = application_link
         self.linkKind = link_kind
         self.expiration = expiration
+        self.password = password
+        self.passwordProtected = True if password else password_protected
+        self.role = role
+        self.shareId = share_id
+        self.trackLinkUsers = track_link_users
 
     @property
     def entity_type_name(self):

office365/sharepoint/sharing/object_sharing_information.py

@@ -110,8 +110,7 @@ class ObjectSharingInformation(BaseEntity):
         :param str list_id: The list identifier for the list which contains the list item for which
         the sharing state is requested.
         :param office365.sharepoint.client_context.ClientContext context: SharePoint client context
-        :param BaseEntity return_type: Return type
-        :return: ObjectSharingInformation
+        :param ObjectSharingInformation return_type: Return type
         """
         binding_type = ObjectSharingInformation(context)
         payload = {
@@ -131,6 +130,70 @@ class ObjectSharingInformation(BaseEntity):
         context.add_query(qry)
         return return_type
 
+    @property
+    def anonymous_edit_link(self):
+        """
+        Provides the URL that allows an anonymous user to edit the securable object.
+        If such a URL is not available, this property will provide an empty string.
+
+        :rtype: str
+        """
+        return self.properties.get('AnonymousEditLink', None)
+
+    @property
+    def anonymous_view_link(self):
+        """
+        Provides the URL that allows an anonymous user to view the securable object.
+        If such a URL is not available, this property will provide an empty string.
+
+        :rtype: str
+        """
+        return self.properties.get('AnonymousViewLink', None)
+
+    @property
+    def can_be_shared(self):
+        """
+        Indicates whether the current securable object can be shared.
+        :rtype: bool
+        """
+        return self.properties.get('CanBeShared', None)
+
+    @property
+    def can_be_unshared(self):
+        """
+        Indicates whether the current securable object can be unshared.
+        :rtype: bool
+        """
+        return self.properties.get('CanBeUnshared', None)
+
+    @property
+    def can_manage_permissions(self):
+        """
+        Specifies whether the current user is allowed to change the permissions of the securable object.
+        :rtype: bool
+        """
+        return self.properties.get('CanManagePermissions', None)
+
+    @property
+    def has_pending_access_requests(self):
+        """
+        Provides information about whether there are any pending access requests for the securable object.
+
+        This information is only provided if the current user has sufficient permissions to view any pending
+        access requests. If the current user does not have such permissions, this property will return false.
+        :rtype: bool
+        """
+        return self.properties.get('HasPendingAccessRequests', None)
+
+    @property
+    def has_permission_levels(self):
+        """
+        Indicates whether the object sharing information contains permissions information in addition to the identities
+        of the users who have access to the securable object.
+        :rtype: bool
+        """
+        return self.properties.get('HasPermissionLevels', None)
+
     @property
     def sharing_links(self):
         """Indicates the collection of all available sharing links for the securable object."""

office365/sharepoint/sharing/object_sharing_information_user.py

@@ -16,6 +16,15 @@ class ObjectSharingInformationUser(BaseEntity):
         """
         return self.properties.get("Email", None)
 
+    @property
+    def sip_address(self):
+        """
+        Specifies the SIP address of the user.
+
+        :rtype: str or None
+        """
+        return self.properties.get("SipAddress", None)
+
     @property
     def login_name(self):
         """