Share via


Web.ForwardObjectLink method

Share an object in SharePoint such as a list item, or site with no Acl changes, even when you do not have permission to share and can't send an access request. Use this method to send the link of the object to site members who already has permission to view the object.

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

Syntax

'Declaration
Public Shared Function ForwardObjectLink ( _
    context As ClientRuntimeContext, _
    url As String, _
    peoplePickerInput As String, _
    emailSubject As String, _
    emailBody As String _
) As SharingResult
'Usage
Dim context As ClientRuntimeContext
Dim url As String
Dim peoplePickerInput As String
Dim emailSubject As String
Dim emailBody As String
Dim returnValue As SharingResult

returnValue = Web.ForwardObjectLink(context, _
    url, peoplePickerInput, emailSubject, _
    emailBody)
public static SharingResult ForwardObjectLink(
    ClientRuntimeContext context,
    string url,
    string peoplePickerInput,
    string emailSubject,
    string emailBody
)

Parameters

  • url
    Type: System.String

    The URL of the web with the path of an object in SharePoint query string parameters.

  • peoplePickerInput
    Type: System.String

    A string of JSON representing users in people picker format. Entries in the people picker must be existing site members and has view permission to the object.

  • emailSubject
    Type: System.String

    The text making up the subject line of the email.

  • emailBody
    Type: System.String

    The text making up the body of the email.

Return value

Type: Microsoft.SharePoint.Client.SharingResult
A SharingResult object which contains a completion script and an optional page to redirect to if desired.

See also

Reference

Web class

Web members

Microsoft.SharePoint.Client namespace