🔍 Code Extractor

Represents the settings the retrieval or creation/update of a tokenized sharing link

Purpose

Represents the settings the retrieval or creation/update of a tokenized sharing link

Source Code

class ShareLinkSettings(ClientValue):
    """Represents the settings the retrieval or creation/update of a tokenized sharing link"""

    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,
        update_password=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.
        :param bool update_password:
        """
        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
        self.updatePassword = update_password

    @property
    def entity_type_name(self):
        return "SP.Sharing.ShareLinkSettings"

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 = ShareLinkSettings(bases)

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class SharingLinkKind 69.7% 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 ShareLinkRequest 69.1% 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 ObjectSharingSettings 68.1% similar

  This class contains the information necessary to read and change the sharing status of a SharePoint object. It also contains a reference to SharePoint specific settings denoted by "SharePointSettings".

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

• class SharingLinkAbilities 67.1% similar

  A data class representing the set of capabilities for tokenized sharing links in SharePoint, indicating which sharing operations are enabled or disabled for the current user.

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

• class SharingLinkInfo 64.5% similar

  A class named SharingLinkInfo

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