Class Element

Elemento

Uma representação de um nó Element XML. 

// Adds up the values listed in a sample XML document and adds a new element
// with the total.
let xml = '<things>' +
    '<plates>12</plates>' +
    '<bowls>18</bowls>' +
    '<cups>25</cups>' +
    '</things>';
const document = XmlService.parse(xml);
const root = document.getRootElement();
const items = root.getChildren();
let total = 0;
for (let i = 0; i < items.length; i++) {
  total += Number(items[i].getText());
}
const totalElement = XmlService.createElement('total').setText(total);
root.addContent(totalElement);
xml = XmlService.getPrettyFormat().format(document);
Logger.log(xml);

Métodos

MétodoTipo de retornoBreve descrição
addContent(content)ElementAcrescenta o nó especificado como o último filho do nó Element.
addContent(index, content)ElementInsere o nó especificado no índice indicado entre todos os nós que são filhos imediatos do nó Element.
cloneContent()Content[]Cria cópias não anexadas de todos os nós que são filhos imediatos do nó {@code Element}.
detach()Content|nullDesvincula o nó do nó pai Element.
getAllContent()Content[]Recebe todos os nós que são filhos imediatos do nó {@code Element}.
getAttribute(name)Attribute|nullRecebe o atributo do nó Element com o nome especificado e sem namespace.
getAttribute(name, namespace)Attribute|nullRecebe o atributo do nó Element com o nome e o namespace especificados.
getAttributes()Attribute[]Recebe todos os atributos deste nó Element na ordem em que aparecem no documento.
getChild(name)Element|nullRecebe o primeiro nó Element com o nome especificado e sem namespace que seja um filho imediato deste nó Element.
getChild(name, namespace)Element|nullRecebe o primeiro nó Element com o nome e o namespace especificados que é um filho imediato deste nó Element.
getChildText(name)String|nullRecebe o valor de texto do nó com o nome especificado e sem namespace, se o nó for um filho imediato do nó Element.
getChildText(name, namespace)String|nullRecebe o valor de texto do nó com o nome e o namespace especificados, se o nó for um filho imediato do nó Element.
getChildren()Element[]Recebe todos os nós Element que são filhos imediatos deste nó Element, na ordem em que aparecem no documento.
getChildren(name)Element[]Recebe todos os nós Element com o nome especificado e sem namespace que são filhos imediatos deste nó Element, na ordem em que aparecem no documento.
getChildren(name, namespace)Element[]Recebe todos os nós Element com o nome e o namespace especificados que são filhos imediatos deste nó Element, na ordem em que aparecem no documento.
getContent(index)Content|nullRecebe o nó no índice especificado entre todos os nós que são filhos imediatos do nó {@code Element}.
getContentSize()IntegerRecebe o número de nós que são filhos imediatos do nó {@code Element}.
getDescendants()Content[]Recebe todos os nós que são filhos diretos ou indiretos do nó {@code Element}, na ordem em que aparecem no documento.
getDocument()DocumentRecebe o documento XML que contém o nó {@code Element}.
getName()StringRecebe o nome local do nó Element.
getNamespace()NamespaceRecebe o namespace do nó Element.
getNamespace(prefix)NamespaceRecebe o namespace com o prefixo especificado para o nó Element.
getParentElement()Element|nullRecebe o nó Element pai do nó.
getQualifiedName()StringRecebe o nome local e o prefixo do namespace do nó Element, no formato [namespacePrefix]:[localName].
getText()StringRecebe o valor de texto do nó Element.
getValue()StringRecebe o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento.
isAncestorOf(other)BooleanDetermina se este nó Element é um pai direto ou indireto de um determinado nó Element.
isRootElement()BooleanDetermina se o nó Element é o nó raiz do documento.
removeAttribute(attribute)BooleanRemove o atributo especificado do nó Element, se ele existir.
removeAttribute(attributeName)BooleanRemove o atributo do nó Element com o nome especificado e sem namespace, se esse atributo existir.
removeAttribute(attributeName, namespace)BooleanRemove o atributo do nó Element com o nome e o namespace especificados, se ele existir.
removeContent()Content[]Remove todos os nós que são filhos imediatos do nó {@code Element}.
removeContent(content)BooleanRemove o nó especificado se ele for um filho imediato do nó {@code Element}.
removeContent(index)Content|nullRemove o nó no índice especificado entre todos os nós que são filhos imediatos do nó {@code Element}.
setAttribute(attribute)ElementDefine o atributo especificado para este nó Element.
setAttribute(name, value)ElementDefine o atributo para este nó Element com o nome e o valor especificados, sem namespace.
setAttribute(name, value, namespace)ElementDefine o atributo para este nó Element com o nome, o valor e o namespace especificados.
setName(name)ElementDefine o nome local do nó Element.
setNamespace(namespace)ElementDefine o namespace do nó Element.
setText(text)ElementDefine o valor de texto do nó Element.

Documentação detalhada

addContent(content)

Acrescenta o nó especificado como o último filho do nó Element. O argumento content pode ser um objeto Element ou qualquer objeto de nó que corresponda a um tipo listado em ContentType.

Parâmetros

NomeTipoDescrição
contentContentO nó a ser anexado.

Retornar

Element: o nó Element, para encadeamento.

addContent(index, content)

Insere o nó especificado no índice indicado entre todos os nós que são filhos imediatos do nó Element. O argumento content pode ser um objeto Element ou qualquer objeto de nó que corresponda a um tipo listado em ContentType.

Parâmetros

NomeTipoDescrição
indexIntegerO índice em que o nó será inserido entre todos os nós que são filhos imediatos do nó Element.
contentContentO nó a ser inserido.

Retornar

Element: o nó Element, para encadeamento.

cloneContent()

Cria cópias não anexadas de todos os nós que são filhos imediatos do nó {@code Element}.

Retornar

Content[]: uma matriz de cópias não anexadas de todos os nós que são filhos imediatos do nó {@code Element}.

detach()

Desvincula o nó do nó pai Element. Se o nó não tiver um elemento pai, esse método não terá efeito.

Retornar

Content|null: o nó desconectado.

getAllContent()

Recebe todos os nós que são filhos imediatos do nó {@code Element}.

Retornar

Content[]: uma matriz de todos os nós que são filhos imediatos do nó {@code Element}.

getAttribute(name)

Recebe o atributo do nó Element com o nome especificado e sem namespace. Se não houver um atributo assim, esse método vai retornar null.

Parâmetros

NomeTipoDescrição
nameStringO nome do atributo.

Retornar

Attribute|null: o atributo ou null se não houver um atributo com o nome especificado e nenhum namespace.

getAttribute(name, namespace)

Recebe o atributo do nó Element com o nome e o namespace especificados. Se não houver um nó desse tipo, o método vai retornar null.

Parâmetros

NomeTipoDescrição
nameStringO nome do atributo.
namespaceNamespaceO namespace do atributo.

Retornar

Attribute|null: o atributo ou null se não houver um atributo com o nome e o namespace especificados.

getAttributes()

Recebe todos os atributos deste nó Element na ordem em que aparecem no documento.

Retornar

Attribute[]: uma matriz de todos os atributos deste nó Element.

getChild(name)

Recebe o primeiro nó Element com o nome especificado e sem namespace que seja um filho imediato deste nó Element. Se não houver um nó assim, esse método vai retornar null.

Parâmetros

NomeTipoDescrição
nameStringO nome do nó filho Element.

Retornar

Element|null: o nó Element ou null se não houver um nó filho Element imediato com o nome especificado e nenhum namespace.

getChild(name, namespace)

Recebe o primeiro nó Element com o nome e o namespace especificados que é um filho imediato deste nó Element. Se não houver um nó assim, esse método vai retornar null.

Parâmetros

NomeTipoDescrição
nameStringO nome do nó filho Element.
namespaceNamespaceO namespace do nó filho Element.

Retornar

Element|null: o nó Element ou null se não houver um nó filho Element imediato com o nome e o namespace especificados.

getChildText(name)

Recebe o valor de texto do nó com o nome especificado e sem namespace, se o nó for um filho imediato do nó Element. Se não houver um nó assim, esse método vai retornar null.

Parâmetros

NomeTipoDescrição
nameStringO nome do nó filho.

Retornar

String|null: o valor de texto do nó filho ou null se não houver um nó filho imediato com o nome e o namespace especificados.

getChildText(name, namespace)

Recebe o valor de texto do nó com o nome e o namespace especificados, se o nó for um filho imediato do nó Element. Se não houver um nó assim, esse método vai retornar null.

Parâmetros

NomeTipoDescrição
nameStringO nome do nó filho.
namespaceNamespaceO namespace do nó filho.

Retornar

String|null: o valor de texto do nó filho ou null se não houver um nó filho imediato com o nome e o namespace especificados.

getChildren()

Recebe todos os nós Element que são filhos imediatos deste nó Element, na ordem em que aparecem no documento.

Retornar

Element[]: uma matriz de todos os nós Element que são filhos imediatos deste nó Element.

getChildren(name)

Recebe todos os nós Element com o nome especificado e sem namespace que são filhos imediatos deste nó Element, na ordem em que aparecem no documento.

Parâmetros

NomeTipoDescrição
nameStringO nome dos nós filhos Element.

Retornar

Element[]: uma matriz de todos os nós Element com o nome especificado e sem namespace que são filhos imediatos deste nó Element.

getChildren(name, namespace)

Recebe todos os nós Element com o nome e o namespace especificados que são filhos imediatos deste nó Element, na ordem em que aparecem no documento.

Parâmetros

NomeTipoDescrição
nameStringO nome dos nós filhos Element.
namespaceNamespaceO namespace dos nós filhos Element.

Retornar

Element[]: uma matriz de todos os nós Element com o nome e o namespace especificados que são filhos imediatos deste nó Element.

getContent(index)

Recebe o nó no índice especificado entre todos os nós que são filhos imediatos do nó {@code Element}. Se não houver um nó no índice especificado, esse método vai retornar null.

Parâmetros

NomeTipoDescrição
indexIntegerO índice do nó entre todos os nós que são filhos imediatos do nó {@code Element}.

Retornar

Content|null: o nó ou null se não houver um nó no índice especificado.

getContentSize()

Recebe o número de nós que são filhos imediatos do nó {@code Element}.

Retornar

Integer: o número de nós que são filhos imediatos do nó {@code Element}.

getDescendants()

Recebe todos os nós que são filhos diretos ou indiretos do nó {@code Element}, na ordem em que aparecem no documento.

Retornar

Content[]: uma matriz de todos os nós que são filhos diretos ou indiretos do nó {@code Element}.

getDocument()

Recebe o documento XML que contém o nó {@code Element}.

Retornar

Document: o documento que contém o nó {@code Element}.

getName()

Recebe o nome local do nó Element. Se o nó tiver um prefixo de namespace, use getQualifiedName() ou getNamespace().getPrefix() para receber o prefixo.

Retornar

String: o nome local do nó Element.

getNamespace()

Recebe o namespace do nó Element.

Retornar

Namespace: o namespace do nó Element.

getNamespace(prefix)

Recebe o namespace com o prefixo especificado para o nó Element.

Parâmetros

NomeTipoDescrição
prefixStringO prefixo do namespace.

Retornar

Namespace: o namespace com o prefixo especificado para o nó Element.

getParentElement()

Recebe o nó Element pai do nó. Se o nó não tiver um pai, esse método vai retornar null.

Retornar

Element|null: o nó Element pai.

getQualifiedName()

Recebe o nome local e o prefixo do namespace do nó Element, no formato [namespacePrefix]:[localName]. Se o nó não tiver um prefixo de namespace, use getName().

Retornar

String: o nome local e o prefixo do namespace do nó Element, no formato [namespacePrefix]:[localName].

getText()

Recebe o valor de texto do nó Element.

Retornar

String: o valor de texto do nó Element.

getValue()

Recebe o valor de texto de todos os nós que são filhos diretos ou indiretos do nó, na ordem em que aparecem no documento.

Retornar

String: o valor de texto de todos os nós que são filhos diretos ou indiretos do nó.

isAncestorOf(other)

Determina se este nó Element é um pai direto ou indireto de um determinado nó Element.

Parâmetros

NomeTipoDescrição
otherElementO outro nó Element.

Retornar

Boolean: true se este nó Element for um pai direto ou indireto do nó Element especificado; false caso contrário.

isRootElement()

Determina se o nó Element é o nó raiz do documento.

Retornar

Boolean: true se o nó Element for o nó raiz do documento; false se não for.

removeAttribute(attribute)

Remove o atributo especificado do nó Element, se ele existir.

Parâmetros

NomeTipoDescrição
attributeAttributeO atributo.

Retornar

Boolean: true se o atributo existia e foi removido; false se não.

removeAttribute(attributeName)

Remove o atributo do nó Element com o nome especificado e sem namespace, se esse atributo existir.

Parâmetros

NomeTipoDescrição
attributeNameStringO nome do atributo.

Retornar

Boolean: true se o atributo existia e foi removido; false se não.

removeAttribute(attributeName, namespace)

Remove o atributo do nó Element com o nome e o namespace especificados, se ele existir.

Parâmetros

NomeTipoDescrição
attributeNameStringO nome do atributo.
namespaceNamespaceO namespace do atributo.

Retornar

Boolean: true se o atributo existia e foi removido; false se não.

removeContent()

Remove todos os nós que são filhos imediatos do nó {@code Element}.

Retornar

Content[]: uma matriz de todos os nós que eram filhos imediatos do nó {@code Element} antes de serem removidos.

removeContent(content)

Remove o nó especificado se ele for um filho imediato do nó {@code Element}. O argumento content pode ser um objeto Element ou qualquer objeto de nó que corresponda a um tipo listado em ContentType.

Parâmetros

NomeTipoDescrição
contentContentO nó a ser removido.

Retornar

Boolean: true se o nó era um filho imediato e foi removido; false caso contrário.

removeContent(index)

Remove o nó no índice especificado entre todos os nós que são filhos imediatos do nó {@code Element}. Se não houver um nó no índice especificado, esse método vai retornar null.

Parâmetros

NomeTipoDescrição
indexIntegerO índice do nó entre todos os nós que são filhos imediatos do nó {@code Element}.

Retornar

Content|null: o nó removido ou null se não houver um nó no índice especificado.

setAttribute(attribute)

Define o atributo especificado para este nó Element.

Parâmetros

NomeTipoDescrição
attributeAttributeO atributo a ser definido.

Retornar

Element: o nó Element, para encadeamento.

setAttribute(name, value)

Define o atributo para este nó Element com o nome e o valor especificados, sem namespace.

Parâmetros

NomeTipoDescrição
nameStringO nome do atributo a ser definido.
valueStringO valor do atributo a ser definido.

Retornar

Element: o nó Element, para encadeamento.

setAttribute(name, value, namespace)

Define o atributo para este nó Element com o nome, o valor e o namespace especificados.

Parâmetros

NomeTipoDescrição
nameStringO nome do atributo a ser definido.
valueStringO valor do atributo a ser definido.
namespaceNamespaceO namespace do atributo a ser definido.

Retornar

Element: o nó Element, para encadeamento.

setName(name)

Define o nome local do nó Element. Para definir um prefixo de namespace para o nó, use setNamespace(namespace) com XmlService.getNamespace(prefix, uri).

Parâmetros

NomeTipoDescrição
nameStringO nome local a ser definido.

Retornar

Element: o nó Element, para encadeamento.

setNamespace(namespace)

Define o namespace do nó Element.

Parâmetros

NomeTipoDescrição
namespaceNamespaceO namespace a ser definido.

Retornar

Element: o nó Element, para encadeamento.

setText(text)

Define o valor de texto do nó Element. Se o nó já tiver um valor de texto ou nós filhos, esse método vai substituir o conteúdo antigo. Para anexar ou inserir conteúdo, use addContent(content) ou addContent(index, content).

Parâmetros

NomeTipoDescrição
textStringO texto a ser definido.

Retornar

Element: o nó Element, para encadeamento.