GetLayoutObjectOwnerInfo

Retorna um objeto JSON com informações de propriedade sobre um objeto de layout.

Formato 

GetLayoutObjectOwnerInfo ( objectID )

Parâmetros 

objectID – texto que especifica o identificador exclusivo universal (UUID) ou o ID do proprietário de um objeto de layout.

Tipo de dados retornado 

texto

Originada na versão 

19.2.2

Descrição 

Esta função procura um objeto de layout cujo UUID ou ID de proprietário corresponda ao parâmetro objectID e retorna informações sobre o proprietário do objeto. Os itens a seguir são considerados proprietários de um objeto de layout:

  • O layout no qual o objeto está;

  • O complemento no qual o objeto está, se aplicável.

Quando um objeto de layout é adicionado a um layout, um UUID é atribuído a ele. Quando uma instância de um complemento é adicionada a um layout, um ID de proprietário é atribuído a ele. O valor do parâmetro objectID pode ser o UUID do objeto ou o ID do proprietário. Consulte a Função LayoutObjectUUID.

Se estiver desenvolvendo um complemento, você pode usar esta função para obter informações no tempo de execução sobre objetos de layout em uma instância do seu complemento.

No exemplo a seguir do objeto JSON retornado, o objeto de layout está em uma instância de um complemento no layout de Tarefas.

Copiar
{
    "APIVers" : 1,
    "Object"
    {
        "UUID" : "D7C30E98-1924-4BF5-A263-53E9CD36862F",
        "Index" : 1,
        "Name" : "ActivityTimeLineWV_970E9CAE-D6FA-40DE-ACFA-14D110731F82",
        "Owners"
        {
            "Add-on"
            {
                "InstanceID" : "38EA3124-9CFD-4490-A634-A0A72A613145"
            },
            "Layout"
            {
                "UUID" : "D7C30E98-1924-4BF5-A263-53E9CD36862F",
                "Name" : "Tarefas"
            }
        }
    }
}

A tabela a seguir descreve os elementos do objeto JSON retornado.

Elemento JSON

Descrição

APIVers

Valor numérico para a versão da estrutura deste objeto JSON. Se a estrutura desse objeto JSON mudar em uma versão subsequente, esse número mudará.

Object.UUID

UUID do objeto de layout especificado

Object.Index

Índice do objeto no layout (começando com zero)

Object.Name

Nome do objeto de layout (consulte Nomeação de objetos)

Object.Owners
.Add-on.InstanceID

ID da instância do complemento na qual o objeto está. Se o objeto não estiver em um complemento, o elemento Add-on é inexistente.

Object.Owners
.Layout.UUID

UUID do layout no qual o objeto está

Object.Owners
.Layout.Name
Nome do layout no qual o objeto está

Exemplo 1 

Retorna o objeto JSON mostrado acima.

Copiar
GetLayoutObjectOwnerInfo ( "970E9CAE-D6FA-40DE-ACFA-14D110731F82" )