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ó fornecido no índice fornecido 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()ContentDesconecta o nó do nó Element pai.
getAllContent()Content[]Recebe todos os nós que são filhos imediatos do nó {@code Element}.
getAttribute(name)AttributeRecebe o atributo para este nó Element com o nome fornecido e sem namespace.
getAttribute(name, namespace)AttributeRecebe o atributo para este nó Element com o nome e o namespace fornecidos.
getAttributes()Attribute[]Extrai todos os atributos desse nó Element, na ordem em que aparecem no documento.
getChild(name)ElementExtrai o primeiro nó Element com o nome fornecido e nenhum namespace que seja um filho imediato desse nó Element.
getChild(name, namespace)ElementRecebe o primeiro nó Element com o nome e o namespace fornecidos, que é um filho imediato desse nó Element.
getChildText(name)StringRecebe o valor de texto do nó com o nome fornecido e sem namespace, se o nó for um filho imediato do nó Element.
getChildText(name, namespace)StringExtrai o valor de texto do nó com o nome e o namespace fornecidos, se o nó for 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 fornecido e nenhum namespace que sejam 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 fornecidos que são filhos imediatos deste nó Element, na ordem em que aparecem no documento.
getContent(index)ContentExtrai o nó no índice fornecido 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()DocumentConsegue 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 fornecido para o nó Element.
getParentElement()ElementRecebe o nó Element pai do nó.
getQualifiedName()StringExtrai 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 fornecido para este nó Element, se ele existir.
removeAttribute(attributeName)BooleanRemove o atributo desse nó Element com o nome fornecido e sem namespace, se esse atributo existir.
removeAttribute(attributeName, namespace)BooleanRemove o atributo desse nó Element com o nome e o namespace fornecidos, se esse atributo existir.
removeContent()Content[]Remove todos os nós que são filhos imediatos do nó {@code Element}.
removeContent(content)BooleanRemove o nó fornecido, se ele for um filho imediato do nó {@code Element}.
removeContent(index)ContentRemove o nó no índice fornecido entre todos os nós que são filhos imediatos do nó {@code Element}.
setAttribute(attribute)ElementDefine o atributo fornecido para este nó Element.
setAttribute(name, value)ElementDefine o atributo para este nó Element com o nome, o valor e o namespace fornecidos.
setAttribute(name, value, namespace)ElementDefine o atributo para este nó Element com o nome, o valor e o namespace fornecidos.
setName(name)ElementDefine o nome local do nó Element.
setNamespace(namespace)ElementDefine o namespace para o 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ó fornecido no índice fornecido 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 inserir o nó 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 node {@code Element}

detach()

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

Retornar

Content: o nó removido

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 para este nó Element com o nome fornecido e sem namespace. Se não existir esse atributo, o método vai retornar null.

Parâmetros

NomeTipoDescrição
nameStringo nome do atributo

Retornar

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

getAttribute(name, namespace)

Recebe o atributo para este nó Element com o nome e o namespace fornecidos. Se não houver esse nó, o método retornará null.

Parâmetros

NomeTipoDescrição
nameStringo nome do atributo
namespaceNamespaceo namespace do atributo

Retornar

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

getAttributes()

Extrai todos os atributos desse nó Element, na ordem em que aparecem no documento.

Retornar

Attribute[]: uma matriz de todos os atributos para este nó Element

getChild(name)

Extrai o primeiro nó Element com o nome fornecido e nenhum namespace que seja um filho imediato desse nó Element. Se não houver esse nó, o método retornará null.

Parâmetros

NomeTipoDescrição
nameStringo nome do nó Element filho

Retornar

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

getChild(name, namespace)

Recebe o primeiro nó Element com o nome e o namespace fornecidos, que é um filho imediato desse nó Element. Se não houver esse nó, o método retornará null.

Parâmetros

NomeTipoDescrição
nameStringo nome do nó Element filho
namespaceNamespaceo namespace do nó Element filho

Retornar

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

getChildText(name)

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

Parâmetros

NomeTipoDescrição
nameStringo nome do nó filho

Retornar

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

getChildText(name, namespace)

Extrai o valor de texto do nó com o nome e o namespace fornecidos, se o nó for filho imediato do nó Element. Se não houver esse nó, o método retornará null.

Parâmetros

NomeTipoDescrição
nameStringo nome do nó filho
namespaceNamespaceo namespace do nó filho

Retornar

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

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 fornecido e nenhum namespace que sejam filhos imediatos deste nó Element, na ordem em que aparecem no documento.

Parâmetros

NomeTipoDescrição
nameStringo nome dos nós Element filhos

Retornar

Element[]: uma matriz de todos os nós Element com o nome fornecido 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 fornecidos que são filhos imediatos deste nó Element, na ordem em que aparecem no documento.

Parâmetros

NomeTipoDescrição
nameStringo nome dos nós Element filhos
namespaceNamespaceo namespace dos nós Element filhos

Retornar

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

getContent(index)

Extrai o nó no índice fornecido entre todos os nós que são filhos imediatos do nó {@code Element}. Se não houver nenhum nó no índice fornecido, o método 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: o nó ou null se não houver nenhum nó no índice fornecido.

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()

Consegue 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 fornecido para o nó Element.

Parâmetros

NomeTipoDescrição
prefixStringo prefixo do namespace

Retornar

Namespace: o namespace com o prefixo fornecido 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: o nó Element pai

getQualifiedName()

Extrai 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 fornecido; 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 fornecido para este 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 desse nó Element com o nome fornecido 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 desse nó Element com o nome e o namespace fornecidos, se esse atributo 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ó fornecido, 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 filho imediato e foi removido; false, caso contrário.

removeContent(index)

Remove o nó no índice fornecido entre todos os nós que são filhos imediatos do nó {@code Element}. Se não houver nenhum nó no índice fornecido, o método 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: o nó que foi removido ou null se não houver nenhum nó no índice especificado.

setAttribute(attribute)

Define o atributo fornecido 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, o valor e o namespace fornecidos.

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 fornecidos.

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) em conjunto 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 para o 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 algum nó filho, 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