ObjectSharingInformation.GetObjectSharingInformation method

Gets information about the sharing state for a specified securable object.

Namespace:  Microsoft.SharePoint.Client
Assembly:  Microsoft.SharePoint.Client (in Microsoft.SharePoint.Client.dll)

Syntax

'Declaration
Public Shared Function GetObjectSharingInformation ( _
    context As ClientRuntimeContext, _
    securableObject As SecurableObject, _
    excludeCurrentUser As Boolean, _
    excludeSiteAdmin As Boolean, _
    excludeSecurityGroups As Boolean, _
    retrieveAnonymousLinks As Boolean, _
    retrieveUserInfoDetails As Boolean, _
    checkForAccessRequests As Boolean, _
    retrievePermissionLevels As Boolean _
) As ObjectSharingInformation
'Usage
Dim context As ClientRuntimeContext
Dim securableObject As SecurableObject
Dim excludeCurrentUser As Boolean
Dim excludeSiteAdmin As Boolean
Dim excludeSecurityGroups As Boolean
Dim retrieveAnonymousLinks As Boolean
Dim retrieveUserInfoDetails As Boolean
Dim checkForAccessRequests As Boolean
Dim retrievePermissionLevels As Boolean
Dim returnValue As ObjectSharingInformation

returnValue = ObjectSharingInformation.GetObjectSharingInformation(context, _
    securableObject, excludeCurrentUser, _
    excludeSiteAdmin, excludeSecurityGroups, _
    retrieveAnonymousLinks, retrieveUserInfoDetails, _
    checkForAccessRequests, retrievePermissionLevels)

public static ObjectSharingInformation GetObjectSharingInformation(
    ClientRuntimeContext context,
    SecurableObject securableObject,
    bool excludeCurrentUser,
    bool excludeSiteAdmin,
    bool excludeSecurityGroups,
    bool retrieveAnonymousLinks,
    bool retrieveUserInfoDetails,
    bool checkForAccessRequests,
    bool retrievePermissionLevels
)

Parameters

• context
  Type: Microsoft.SharePoint.Client.ClientRuntimeContext

  The runtime context.

• securableObject
  Type: Microsoft.SharePoint.Client.SecurableObject

  Specifies the securable object for which to obtain sharing information.

• excludeCurrentUser
  Type: System.Boolean

  Specifies whether the returned sharing information should exclude information about the current user. If true, the current user information is excluded.

• excludeSiteAdmin
  Type: System.Boolean

  Specifies whether the returned sharing information should exclude information about site administration users. If true, the site administration user information is excluded.

• excludeSecurityGroups
  Type: System.Boolean

  Specifies whether the returned sharing information should exclude security groups from the list of shared with users. If true, security groups are excluded.

• retrieveAnonymousLinks
  Type: System.Boolean

  Specifies whether the returned sharing information should include information about anonymous links. If true, information about anonymous links is included.

• retrieveUserInfoDetails
  Type: System.Boolean

  Specifies whether the returned sharing information should include additional user information. If true, additional user information is included.

• checkForAccessRequests
  Type: System.Boolean

  Specifies whether to retrieve access requests information. If true, access requests information is retrieved.

• retrievePermissionLevels
  Type: System.Boolean

  Specifies whether to retrieve sharing information with permission levels. This is only applicable for document sharing in a library that has IsDocumentSharingEnabled as true and the View and Edit role definitions exist. When these conditions are met, this method will retrieve sharing information for the document with permission levels. One example of this usage is Shared With Dialog, in which it displays permission levels for document sharing when IsDocumentSharingEnabled is enabled.

Return value

Type: Microsoft.SharePoint.Client.ObjectSharingInformation
The securable object sharing information.

See also

Reference

ObjectSharingInformation class

ObjectSharingInformation members

Microsoft.SharePoint.Client namespace