🔍 Code Extractor

This class stores basic overview information about the link URL, including limited data about the object the link URL refers to and any additional sharing link data if the link URL is a tokenized sharing link.

Purpose

This class stores basic overview information about the link URL, including limited data about the object the link URL refers to and any additional sharing link data if the link URL is a tokenized sharing link.

Source Code

class SharingLinkData(ClientValue):
    """
    This class stores basic overview information about the link URL, including limited data
    about the object the link URL refers to and any additional sharing link data if the link URL
    is a tokenized sharing link.
    """

    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,
        is_manage_list_link=None,
        is_originated_from_sharing_flow=None,
        is_review_link=None,
        is_sharing_link=None,
        is_writable=None,
        link_kind=None,
        object_type=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.
        :param bool is_manage_list_link:
        :param bool is_originated_from_sharing_flow:
        :param bool is_review_link: Indicates if the link URL is a tokenized sharing link that supports review
            operations. This value MUST be true only if the link URL is a tokenized sharing link which is configured to
            support access with the review role, otherwise this MUST be false.
        :param bool is_sharing_link: Indicates if the link URL is a tokenized sharing link. This value MUST be true
             only if the link URL is a tokenized sharing link, otherwise this MUST be false.
        :param bool is_writable: Indicates if the link URL is a tokenized sharing link that supports write/edit
             operations. This value MUST be true only if the link URL is a tokenized sharing link which is configured
             to support access with the edit role, otherwise this MUST be false.
        :param int link_kind: The kind of link that the link URL refers to.
        :param int object_type: The type of object the link URL refers to.
        """
        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
        self.IsManageListLink = is_manage_list_link
        self.IsOriginatedFromSharingFlow = is_originated_from_sharing_flow
        self.IsReviewLink = is_review_link
        self.IsSharingLink = is_sharing_link
        self.IsWritable = is_writable
        self.LinkKind = link_kind
        self.ObjectType = object_type

Parameters

Parameter Details

bases: Parameter of type ClientValue

Return Value

Returns unspecified type

Class Interface

Methods

Required Imports

from office365.runtime.client_value import ClientValue

Usage Example

# Example usage:
# result = SharingLinkData(bases)

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class SharingLinkInfo 75.9% similar

  A class named SharingLinkInfo

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/links/info.py

• class SharingLinkKind 70.1% similar

  An enumeration-style class that defines constants representing different types of tokenized sharing links for objects, including direct links, organization access links, and anonymous access links with varying permission levels.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/links/kind.py

• class SharingLinkDefaultTemplate 70.1% similar

  A data class representing a default template for sharing links in SharePoint, containing link details information.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/links/default_template.py

• class ShareLinkRequest 67.6% similar

  A data class representing a request for retrieving or creating a tokenized sharing link in SharePoint, encapsulating all necessary parameters for link configuration.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/links/share_request.py

• class SharingLinkAccessRequest 66.2% similar

  A data class representing extended values required for requesting access to SharePoint objects exposed through tokenized sharing links, including password and access persistence options.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/links/access_request.py