Contexto do cliente (referência do cliente)

Publicado: novembro de 2016

Aplicável a: Dynamics CRM 2015

Seu código precisará funcionar em um contexto onde um número de variáveis não é conhecido no tempo de criação. O objeto de contexto fornece métodos para recuperar informações específicas a uma organização, um usuário ou parâmetros passados para uma página.

O objeto de contexto está disponível nos formulários fazendo referência ao Xrm.Page.context.

Para os recursos da Web executados fora de um formulário, use Função GetGlobalContext para recuperar um objeto de contexto.

Propriedades e métodos de contexto

• cliente
  Permite o acesso aos métodos getClient, getClientState e getFormFactor que você pode usar para determinar qual cliente está sendo usado, se o cliente está conectado ao servidor e o tipo de dispositivo utilizado.

• getClientUrl
  Retorna à URL base que foi usada para acessar o aplicativo.

• getCurrentTheme
  Retorna uma cadeia de caracteres que representa o tema atual do Microsoft Office Outlook escolhido pelo usuário.

• getIsAutoSaveEnabled
  Retorna Autosave se estiver habilitado para a organização.

• getOrgLcid
  Retorna o valor do identificador do código de idioma (LCID) que representa o idioma base da organização.

• getOrgUniqueName
  Retorna o valor de texto exclusivo do nome da organização.

• getQueryStringParameters
  Retorna um objeto de dicionário de pares de valores chaves que representam os argumentos da cadeia de caracteres de consulta que são transmitidos para a página.

• getTimeZoneOffsetMinutes
  Retorna a diferença entre a hora local e o UTC (Tempo Universal Coordenado).

  Esse método foi introduzido no Atualização 1 do Microsoft Dynamics CRM Online 2015.

• getUserId
  Retorna o GUID do valor SystemUser.Id para o usuário atual.

• getUserLcid
  Retorna o valor LCID que representa o idioma provisionado que o usuário selecionou como o idioma de sua preferência.

• getUserName
  Retorna o nome do usuário atual.

• getUserRoles
  Retorna uma matriz de cadeias de caracteres que representa os valores GUID para cada direito de acesso que o usuário é associado com outras equipes que o usuário está associado.

• prependOrgName
  Anexa o nome da organização para o caminho especificado.

• Métodos removidos
  Os métodos removidos são substituídos ou obsoletos com outro método. Você deve garantir que esses métodos não sejam usados em seus scripts.

  Os métodos getAuthenticationHeader e getServerUrl são substituídos com Microsoft Dynamics CRM 2011 e não estão mais presentes no Atualização do Microsoft Dynamics CRM 2015 e Microsoft Dynamics CRM Online 2015.

  Os métodos isOutlookClient e isOutlookOnline foram substituídos com o Microsoft Dynamics CRM 2013 e não estão mais presentes no Atualização do Microsoft Dynamics CRM 2015 e Microsoft Dynamics CRM Online 2015.

cliente

O Microsoft Dynamics CRM 2013 e Microsoft Dynamics CRM Online incluiu o objeto do cliente que contém os métodos getClient e getClientState para obter informações sobre o cliente.

O Atualização 1 do Microsoft Dynamics CRM Online 2015 adicionou o método getFormFactor.

getClient

Retorna um valor para indicar qual cliente o script está executando.

context.client.getClient()

Use em vez do método isOutlookClient removido.

• Valor de Retorno
  Tipo: Cadeia de caracteres

  Os valores retornados são:

  Cliente	Valor
  Navegador	Web
  Outlook	Outlook
  Celular	Celular

getClientState

Use em vez do método isOutlookOnline removido.

Retorna um valor para indicar o estado do cliente.

context.client.getClientState()

• Valor de Retorno
  Tipo: Cadeia de caracteres

  Os valores possíveis retornados são:

  Cliente	Valores retornados
  Web, Outlook, Móvel	Online
  Outlook, Mobile	Offline

getFormFactor

Use este método para obter informações sobre o tipo de dispositivo utilizado pelo usuário.

context.client.getFormFactor()

• Valor de Retorno
  Tipo: Número

  Os valores possíveis retornados são:

  Valor	Fator de formulário
  0	Desconhecido
  1	Desktop
  2	Tablet
  3	Telefone

• Comentários
  Esse método foi apresentado no Atualização 1 do Microsoft Dynamics CRM Online 2015

getClientUrl

Retorna à URL base que foi usada para acessar o aplicativo.

context.getClientUrl()

Use em vez do método getServerUrl removido.

O valor retornado é semelhante àquele listado na tabela a seguir.

• Valor de Retorno
  Tipo: Cadeia de caracteres

getCurrentTheme

Retorna uma cadeia de caracteres que representa o tema atual do Microsoft Office Outlook escolhido pelo usuário.

context.getCurrentTheme()

• Valor de Retorno
  Tipo: Cadeia de caracteres

Use essas informações para selecionar um tema adequado para seus recursos da Web HTML e Silverlight quando exibido no Microsoft Dynamics CRM para Outlook. A tabela a seguir lista os valores a serem retornados deste método.

getIsAutoSaveEnabled

Este método é novo para Atualização do Microsoft Dynamics CRM 2015 e Microsoft Dynamics CRM Online 2015

Retorna Autosave se estiver habilitado para a organização.

context.getIsAutoSaveEnabled()

• Valor de Retorno
  Tipo: Booleano

  Observação

  Essa função retorna o valor definido no momento em que página é aberta. Para testar o código usando esse valor, atualize a página depois de alterar o valor para obter o novo valor.

  Para obter mais informações:TechNet: Gerenciar o salvamento automático.

getOrgLcid

Retorna o valor LCID que representa o idioma base da organização.

context.getOrgLcid()

• Valor de Retorno
  Tipo: Número

  Exemplo: 1033 indica o idioma inglês.Os valores de ID de localidade válidos podem ser encontrados em Gráfico de LCID (ID de localidade).

  1033
  

getOrgUniqueName

Retorna o valor de texto exclusivo do nome da organização.

context.getOrgUniqueName()

• Valor de Retorno
  Tipo: Cadeia de caracteres

  Exemplo: Isso que corresponde ao valor do nome da organização

  "adventureworkscycle"
  

getQueryStringParameters

Retorna um objeto de dicionário de pares de valores chaves que representam os argumentos da cadeia de caracteres de consulta que são transmitidos para a página.

context.getQueryStringParameters()

• Valor de Retorno
  Tipo: Objeto

getTimeZoneOffsetMinutes

Retorna a diferença entre a hora local e o UTC (Tempo Universal Coordenado).

context.getTimeZoneOffsetMinutes()

• Valor de Retorno
  Tipo: Número

getUserId

Retorna o GUID do valor SystemUser.Id para o usuário atual.

context.getUserId()

• Valor de Retorno
  Tipo: Cadeia de caracteres

  Exemplo:

  "{B05EC7CE-5D51-DF11-97E0-00155DB232D0}"
  

getUserLcid

Retorna o valor LCID que representa o Microsoft Dynamics CRMPacote de Idiomas que o usuário selecionou como o idioma de sua preferência.

context.getUserLcid()

• Valor de Retorno
  Tipo: Número

  Exemplo: 1041 indica o idioma japonês.Os valores de ID de localidade válidos podem ser encontrados em Gráfico de LCID (ID de localidade).

  1041
  

getUserName

Retorna o nome do usuário atual.

context.getUserName()

• Valor de Retorno
  Tipo: Cadeia de caracteres

getUserRoles

Retorna uma matriz de cadeias de caracteres que representa os valores GUID para cada direito de acesso que o usuário é associado com outras equipes que o usuário está associado.

Para obter mais informações sobre as funções de segurança no, consulte Como o acesso baseado no direito pode ser usado para controlar o acesso às entidades no Microsoft Dynamics CRM 2015.

context.getUserRoles()

• Valor de Retorno
  Tipo: Matriz

  Exemplo: Esse usuário tem somente um direito de acesso associado à sua conta de usuário. A representação JSON dessa matriz com um único valor é:

  ["cf4cc7ce-5d51-df11-97e0-00155db232d0"]
  

prependOrgName

Anexa o nome da organização para o caminho especificado.

context.prependOrgName(sPath)

• Argumentos
  Tipo: Cadeia de caracteres

  Um caminho local para um recurso.

• Valor de Retorno
  Tipo: Cadeia de caracteres

  O valor retornado acompanha esse padrão:

  "/"+ OrgName + sPath
  

Métodos removidos

Os métodos removidos são substituídos ou obsoletos com outro método. Você deve garantir que esses métodos não sejam usados em seus scripts.

Os seguintes métodos são substituídos com versões anteriores do Microsoft Dynamics 365 e não estão presentes na versão atual:

• getAuthenticationHeader
  Este método suportado usa os serviços Web Microsoft Dynamics CRM 4.0, que não existe.

• getServerUrl
  Este método é substituído por getClientUrl.

• isOutlookClient
  Este método foi substituído por cliente.getClient.

• isOutlookOnline
  Este método foi substituído por cliente.getClientState.

Confira Também

Função GetGlobalContext e ClientGlobalContext.js.aspx (referência do cliente)
Referência rápida do script de formulário
Criar códigos para os formulários do Microsoft Dynamics CRM 2015
Use o modelo de objeto Xrm.Page
Referência de programação do cliente

© 2017 Microsoft. Todos os direitos reservados. Direitos autorais