🔍 Code Extractor

class SharingLinkInfo

Maturity: 22

A class named SharingLinkInfo

File:
/tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/links/info.py
Lines:
7 - 64
Complexity:
moderate

Purpose

No detailed description available

Source Code

class SharingLinkInfo(ClientValue):
    def __init__(
        self,
        allows_anonymous_access=None,
        application_id=None,
        created=None,
        created_by=Principal(),
        password_protected=None,
        invitations=None,
        redeemed_users=None,
        last_modified_by=Principal(),
        password_last_modified_by=Principal(),
        track_link_users=None,
        share_token_string=None,
        url=None,
    ):
        """
        Specifies the information about the tokenized sharing link.

        :param bool allows_anonymous_access: Indicates whether the tokenized sharing link allows anonymous access.
        :param str application_id:
        :param str created: The UTC date/time string with complete representation for calendar date and time of day
             which represents the time and date of creation of the tokenized sharing link.
        :param Principal created_by: Indicates the principal who created the tokenized sharing link, or null if the
             created by value is not recorded.
        :param bool password_protected:
        :param list[LinkInvitation] invitations: This value contains the current membership list for principals
             that have been Invited to the tokenized sharing link.
        :param list[LinkInvitation] redeemed_users:
        :param Principal last_modified_by: Indicates the principal who last modified the tokenized sharing link.
             This value MUST be null if the last modified by value is not recorded.
        :param Principal password_last_modified_by:
        :param bool track_link_users:
        :param str share_token_string:
        """
        super(SharingLinkInfo, self).__init__()
        self.AllowsAnonymousAccess = allows_anonymous_access
        self.ApplicationId = application_id
        self.Created = created
        self.CreatedBy = created_by
        self.PasswordProtected = password_protected
        self.Invitations = ClientValueCollection(LinkInvitation, invitations)
        self.RedeemedUsers = ClientValueCollection(LinkInvitation, redeemed_users)
        self.LastModifiedBy = last_modified_by
        self.PasswordLastModifiedBy = password_last_modified_by
        self.TrackLinkUsers = track_link_users
        self.ShareTokenString = share_token_string
        self.Url = url

    def __str__(self):
        return self.Url or ""

    def __repr__(self):
        return self.Url or self.entity_type_name

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

Parameters

Name Type Default Kind
bases ClientValue -

Parameter Details

bases: Parameter of type ClientValue

Return Value

Returns unspecified type

Class Interface

Methods

__init__(self, allows_anonymous_access, application_id, created, created_by, password_protected, invitations, redeemed_users, last_modified_by, password_last_modified_by, track_link_users, share_token_string, url)

Purpose: Specifies the information about the tokenized sharing link. :param bool allows_anonymous_access: Indicates whether the tokenized sharing link allows anonymous access. :param str application_id: :param str created: The UTC date/time string with complete representation for calendar date and time of day which represents the time and date of creation of the tokenized sharing link. :param Principal created_by: Indicates the principal who created the tokenized sharing link, or null if the created by value is not recorded. :param bool password_protected: :param list[LinkInvitation] invitations: This value contains the current membership list for principals that have been Invited to the tokenized sharing link. :param list[LinkInvitation] redeemed_users: :param Principal last_modified_by: Indicates the principal who last modified the tokenized sharing link. This value MUST be null if the last modified by value is not recorded. :param Principal password_last_modified_by: :param bool track_link_users: :param str share_token_string:

Parameters:

  • allows_anonymous_access: Parameter
  • application_id: Parameter
  • created: Parameter
  • created_by: Parameter
  • password_protected: Parameter
  • invitations: Parameter
  • redeemed_users: Parameter
  • last_modified_by: Parameter
  • password_last_modified_by: Parameter
  • track_link_users: Parameter
  • share_token_string: Parameter
  • url: Parameter

Returns: None

__str__(self)

Purpose: Internal method: str

Returns: None

__repr__(self)

Purpose: Internal method: repr

Returns: None

entity_type_name(self) property

Purpose: Performs entity type name

Returns: None

Required Imports

from office365.runtime.client_value import ClientValue
from office365.runtime.client_value_collection import ClientValueCollection
from office365.sharepoint.sharing.invitation.link import LinkInvitation
from office365.sharepoint.sharing.principal import Principal

Usage Example

# Example usage:
# result = SharingLinkInfo(bases)

Similar Components

AI-powered semantic similarity - components with related functionality:

  • class SharingLinkData 75.9% similar

    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.

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/links/data.py
  • class SharingLinkKind 69.6% 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 66.9% 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 ShareLinkSettings 64.5% similar

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

    From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/sharepoint/sharing/links/share_settings.py
  • class SharingLinkAbilities 63.4% 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
← Back to Browse