Começar a usar o modelo de objeto do cliente com dados externos no Microsoft Office SharePoint Online

Artigo
03/21/2023

Saiba como usar o modelo de objeto cliente do SharePoint para trabalhar com o BCS (Business Connectivity Services) no SharePoint.

O que é o modelo de objeto cliente do SharePoint?

O modelo de objeto cliente do SharePoint é um conjunto de bibliotecas baseadas no cliente que representam o modelo de objeto do servidor. Eles são incluídos em três DLLs diferentes para acomodar uma variedade de tipos de desenvolvimento. O modelo de objeto do cliente inclui a maioria das principais funções do servidor API. Isso permite acesso aos mesmos tipos de funcionalidade do navegador scripting e também .NET aplicativos web e Silverlight aplicativos.
Para aperfeiçoar e expandir os recursos para trabalhar com dados externos, Business Connectivity Services (BCS) expandiu o modelo de objeto do cliente para incluir a funcionalidade adicional.

Introdução ao uso do modelo de objeto cliente do SharePoint com dados externos

Para desenvolver soluções usando o modelo de objeto do cliente do SharePoint (CSOM), será necessário o seguinte:

SharePoint
Visual Studio 2012
Office Developer Tools para Visual Studio 2012

Para obter informações sobre como configurar seu ambiente de desenvolvimento, consulte Configurando um ambiente de desenvolvimento para BCS no SharePoint.

Para acessar os recursos fornecidos pelo modelo de objeto do cliente, você precisa apenas adicionar referências para os arquivos Microsoft.SharePoint.Client.Runtime.dll e Microsoft.SharePoint.Client.dll em seus projetos. Você também pode usar o modelo de objeto do cliente referenciando as seguintes DLLs no cache de assembly global:

\\Program Files\\Common Files\\Microsoft Shared\\Web Server Extensions\\15\\isapi\\Microsoft.SharePoint.Client.Runtime.dll
\\Program Files\\Common Files\\Microsoft Shared\\Web Server Extensions\\15\\isapi\\Microsoft.SharePoint.Client.dll

Itens essenciais do modelo de objeto cliente do SharePoint

Os artigos a seguir ajudarão você a entender mais sobre o modelo de objeto cliente no SharePoint.

Tabela 1. Conceitos principais para entender o modelo de objeto cliente

Artigo	Descrição
Tipo de conteúdo externo no Microsoft Office SharePoint Online	Saiba mais sobre os tipos de conteúdo externo BCS e o que você precisa para começar a criá-los no Microsoft Office SharePoint Online.
Como usar fontes de OData com Serviços Corporativos de Conectividade do Microsoft Office SharePoint Online	Fornece informações para ajudar a criar tipos de conteúdo externos com base em fontes OData e usando esses dados em componentes do SharePoint ou do Office 2013.
Escolha o conjunto de APIs certo no SharePoint	Saiba mais sobre os vários conjuntos de APIs fornecidos no SharePoint, incluindo o modelo de objeto do servidor, os vários modelos de objeto cliente e o serviço Web REST/OData.
Referência da API do Cliente .NET para SharePoint	Encontre informações sobre as bibliotecas de classe cliente do .NET no SharePoint.
Referência à API JavaScript para SharePoint	Encontre informações sobre as bibliotecas de objetos JavaScript no SharePoint.

O que você pode fazer com o modelo de objeto do cliente?

Você pode usar o modelo de objeto cliente do SharePoint para recuperar, atualizar e gerenciar dados contidos no SharePoint. SharePoint oferece o cliente bibliotecas em formatos diferentes para acomodar a maioria dos desenvolvedores. Para os desenvolvedores da web que estejam usando linguagens de script, a biblioteca do cliente é oferecida em JavaScript. Para desenvolvedores do .NET, ele é oferecido como um cliente .NET gerenciado DLL. Para os desenvolvedores de aplicativos Silverlight, a biblioteca do cliente é fornecida por um Silverlight DLL.

Consulte os artigos na Tabela 2 para obter mais informações sobre o que você pode fazer com o modelo de objeto cliente no SharePoint.

Tabela 2. Tarefas básicas para usar o modelo de objeto cliente com dados externos

Tarefa	Descrição
Realizar operações básicas usando o código de biblioteca cliente do SharePoint	Saiba como escrever código para executar operações básicas com o modelo de objeto cliente do SharePoint.
Como usar a biblioteca de código do cliente para acessar dados externos no SharePoint	Saiba como usar o modelo de objeto cliente do SharePoint para trabalhar com objetos do SharePoint BCS usando scripts baseados em navegador.

A seguir estão alguns exemplos básicos das tarefas que você pode realizar usando o CSOM.

Obtenha uma entidade específica

Este exemplo mostra como obter o contexto do SharePoint e, em seguida, recuperar uma entidade de fonte de dados especificado.


ClientContext ctx = new ClientContext("http://sharepointservername"); 
Web web = ctx.Web; 
ctx.Load(web); 
Entity entity = ctx.Web.GetEntity("http://sharepointservername", "EntityName"); 
ctx.Load(entity); 
ctx.ExecuteQuery();

Criar um chamador genérico

Este exemplo mostra como escrever um chamador genérico para que você possa criar um objeto entity para operar dentro de seu código.

LobSystem lobSystem = entity.GetLobSystem();
ctx.Load(lobSystem);

LobSystemInstanceCollection lobInstances = lobSystem.GetLobSystemInstances();
ctx.Load(lobInstances);
ctx.ExecuteQuery();

LobSystemInstance lsi;
foreach(LobSystemInstance lobInstance in lobInstances)
{
  if (lobInstance.Name.CompareTo("MyLOBSystemInstance") == 0)
  {
    lsi = lobInstance;
  }
}

if (null != lsi)
{
  entity.Execute("MethodInstanceName", lsi, Array.Empty<object>()); 
  ctx.Load(myObj); 
  ctx.ExecuteQuery();
}

Recuperar paginado conjuntos de resultados

O exemplo a seguir mostra como recuperar um dataset paginado filtrado. Nesse caso, o valor de página é 50.


// Find filters for given Method Name. 
FilterCollection fCollection = entity.GetFilters("methodName"); 
ctx.Load(fCollection); 
ctx.ExecuteQuery(); 

fCollection.SetFilterValue("X.Y.Z.Country", 0, "India")
// Assuming that the "RowLimit" filter has the Limit filter type
fCollection.SetFilterValue("RowLimit", 0, 50)

EntityInstanceCollection eCollection = entity.FindFiltered(fCollection, 
"nameOfFinder", lsi); 
ctx.ExecuteQuery();

Consultar informações filtradas

O exemplo a seguir demonstra como retornar um conjunto de resultados filtradas. Nesse caso, a coluna de dados filtrada é o campo X.Y.Z.Country. O código procura por qualquer coisa com o valor de "Índia" e coloca que em uma coleção.


// Find filters for given Method Name. 
FilterCollection fCollection = entity.GetFilters("methodName"); 
ctx.Load(fCollection); 
ctx.ExecuteQuery(); 

fCollection.SetFilterValue("X.Y.Z.Country", 0, "India")

EntityInstanceCollection eCollection = entity.FindFiltered(fCollection, 
"nameOfFinder", lsi); 
ctx.ExecuteQuery();

Além do básico: Saiba mais sobre o modelo de objeto do cliente

Para obter mais informações sobre como usar o modelo de objeto cliente no SharePoint, consulte as informações na Tabela 3.

Tabela 3. Conceitos avançados para o modelo de objeto cliente

Artigo	Descrição
Referência de modelo de objeto cliente do BCS para SharePoint	Resume os objetos disponíveis para criar scripts do lado do cliente usando o modelo de objeto cliente do SharePoint para acessar dados externos expostos pelo BCS.

Compartilhar via