ObjectSharingInformation.GetWebSharingInformation method

Gets information about the sharing state for a specified site.

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

Syntax

'Declaration
Public Shared Function GetWebSharingInformation ( _
    context As ClientRuntimeContext, _
    excludeCurrentUser As Boolean, _
    excludeSiteAdmin As Boolean, _
    excludeSecurityGroups As Boolean, _
    retrieveAnonymousLinks As Boolean, _
    retrieveUserInfoDetails As Boolean, _
    checkForAccessRequests As Boolean _
) As ObjectSharingInformation
'Usage
Dim context As ClientRuntimeContext
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 returnValue As ObjectSharingInformation

returnValue = ObjectSharingInformation.GetWebSharingInformation(context, _
    excludeCurrentUser, excludeSiteAdmin, _
    excludeSecurityGroups, retrieveAnonymousLinks, _
    retrieveUserInfoDetails, checkForAccessRequests)

public static ObjectSharingInformation GetWebSharingInformation(
    ClientRuntimeContext context,
    bool excludeCurrentUser,
    bool excludeSiteAdmin,
    bool excludeSecurityGroups,
    bool retrieveAnonymousLinks,
    bool retrieveUserInfoDetails,
    bool checkForAccessRequests
)

Parameters

• context
  Type: Microsoft.SharePoint.Client.ClientRuntimeContext

  The runtime context.

• 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.

Return value

Type: Microsoft.SharePoint.Client.ObjectSharingInformation
The site sharing information.

See also

Reference

ObjectSharingInformation class

ObjectSharingInformation members

Microsoft.SharePoint.Client namespace