Web.ShareObject método (ClientRuntimeContext, String, String, String, Int32, Boolean, Boolean, Boolean, String, String)

Artigo
05/11/2016

Compartilha um objeto no SharePoint como um documento ou site com usuários externos.

Namespace: Microsoft.SharePoint.Client
Assemblies: Microsoft.SharePoint.Client.Silverlight (em Microsoft.SharePoint.Client.Silverlight.dll); Microsoft.SharePoint.Client.Phone (em Microsoft.SharePoint.Client.Phone.dll)

Sintaxe

'Declaração
Public Shared Function ShareObject ( _
    context As ClientRuntimeContext, _
    url As String, _
    peoplePickerInput As String, _
    roleValue As String, _
    groupId As Integer, _
    propagateAcl As Boolean, _
    sendEmail As Boolean, _
    includeAnonymousLinkInEmail As Boolean, _
    emailSubject As String, _
    emailBody As String _
) As SharingResult
'Uso
Dim context As ClientRuntimeContext
Dim url As String
Dim peoplePickerInput As String
Dim roleValue As String
Dim groupId As Integer
Dim propagateAcl As Boolean
Dim sendEmail As Boolean
Dim includeAnonymousLinkInEmail As Boolean
Dim emailSubject As String
Dim emailBody As String
Dim returnValue As SharingResult

returnValue = Web.ShareObject(context, _
    url, peoplePickerInput, roleValue, _
    groupId, propagateAcl, sendEmail, _
    includeAnonymousLinkInEmail, emailSubject, _
    emailBody)

public static SharingResult ShareObject(
    ClientRuntimeContext context,
    string url,
    string peoplePickerInput,
    string roleValue,
    int groupId,
    bool propagateAcl,
    bool sendEmail,
    bool includeAnonymousLinkInEmail,
    string emailSubject,
    string emailBody
)

Parâmetros

context
Tipo: Microsoft.SharePoint.Client.ClientRuntimeContext

Consulte ClientRuntimeContext

url
Tipo: System.String

A URL completa do site ou do documento que está sendo compartilhado. Exemplos:

 //  for sharing a website
http://contoso.sharepoint.com/sites/extranet1

// for sharing a document
https://contoso.sharepoint.com/sites/extranet1/shared%20documents/mydoc.xlsx

peoplePickerInput
Tipo: System.String

Uma cadeia de JSON formatado que representam os usuários de dados no formato de selecionador de pessoas. A seguir é um exemplo, mas recomendamos que você siga as orientações na API de compartilhamento externo para SharePoint e OneDrive for Business e as amostras de código vinculadas a ele para aprender a gerado esse objeto.

[{
  "Key" : "i:0#.f|membership|somebody.onmicrosoft.com#ext#@somedomain.com", 
  "Description" : "myDomain.onmicrosoft.com#EXT#@somedomain.com", 
  "DisplayText" : "Some Body", 
  "EntityType" : "User", 
  "ProviderDisplayName" : "Tenant", 
  "ProviderName" : "Tenant", 
  "IsResolved" : true, 
  "EntityData" : {
      "MobilePhone" : "", 
      "Email" : "somebody@myDomain.onmicrosoft.com", 
      "Department" : "", "Title" : "somebody@myDomain.onmicrosoft.com", 
      "PrincipalType" : "GUEST_USER"
    }, 
  "MultipleMatches" : []
}]

roleValue
Tipo: System.String

O valor da função compartilhamento para o tipo de permissão para conceder no objeto.

Se você compartilhar um documento que você precisará usar um dos seguintes valores:
- "função: 1073741827"
- "função: 1073741826"
Quando você compartilha um site, use o seguinte formato. Substitua o espaço reservado {ID do grupo} com a id de grupo exclusivas do site onde usuários externos forem atribuídos.

”group:{groupId}”

groupId
Tipo: System.Int32

A ID do grupo a ser adicionado ao. Use zero se não adicionar a um grupo de permissões. (No momento, esse valor será ignorado.)

propagateAcl
Tipo: System.Boolean

Um sinalizador para determinar se as permissões devem ser dispostas nos itens com permissões exclusivas.

sendEmail
Tipo: System.Boolean

Sinalizador para determinar se uma notificação por email deve ser enviada, se o email está configurado.

includeAnonymousLinkInEmail
Tipo: System.Boolean

Se um email está sendo enviado, isso determina se um link de anônimo deve ser adicionado à mensagem.

emailSubject
Tipo: System.String

Texto da linha de assunto do email. (No momento, esse valor será ignorado.)

emailBody
Tipo: System.String

Texto para o corpo do email.

Valor retornado

Tipo: Microsoft.SharePoint.Client.SharingResult
Um objeto de SharingResult que contém o script de conclusão e uma página opcional para redirecionar para.