Referência do JavaScript para gadgets

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Neste documento, descrevemos as classes e os métodos no namespace gadgets.*, alguns dos quais são específicos do recurso. Para ver informações sobre como incluir recursos, consulte a Especificação de gadgets.

Convenções de tipo

Neste documento, usamos as seguintes convenções para os tipos:

Array<T> ou Array.<T>
Uma matriz preenchida apenas com objetos do tipo T. Essa convenção é parecida com a do Java.
Map<K, V> ou Map.<K, V>
Um objeto JavaScript com chaves do tipo K que mapeiam para valores do tipo V. Novamente, essa convenção é semelhante aos genéricos do Java. Muitas vezes, ele é usado para variáveis opt_params.
static
Um tipo marcado com classe estática não tem um construtor público ou particular. Em outras palavras, o tipo é um namespace, não uma classe que pode ser instanciada para criar objetos. Os campos e as funções desse tipo também são marcados como estáticos.
Booleano
Um valor booleano (não um objeto Boolean).
String
Um valor de string (não um objeto String).

Voltar ao início

Classe gadgets.MiniMessage

MiniMessage, usada para criar mensagens que serão exibidas ao usuário no gadget. Casos de uso típicos:

  • Mensagens de status: carregando, salvando etc.
  • Mensagens promocionais: novos recursos, novo gadget etc.
  • Mensagens de depuração/erro: entrada incorreta, falha na conexão com o servidor etc.

Resumo dos construtores

gadgets.MiniMessage(opt_moduleId, opt_container)
Cria um MiniMessage.
 

Resumo dos métodos

 HTMLElement createDismissibleMessage(message, opt_callback)
Cria uma mensagem que pode ser dispensada com um ícone [x] que permite aos usuários dispensar a mensagem.
 HTMLElement createStaticMessage(message)
Cria uma mensagem estática que só pode ser dispensada programaticamente (chamando dismissMessage()).
 HTMLElement createTimerMessage(message, seconds, opt_callback)
Cria uma mensagem que é exibida por um número específico de segundos.
dismissMessage(message)
Dispensar a mensagem especificada.
 

Detalhes do construtor

gadgets.MiniMessage

gadgets.MiniMessage(opt_moduleId, opt_container)
    Cria um MiniMessage.
    Parâmetros:
      String opt_moduleId - ID opcional do módulo
      HTMLElement opt_container - Elemento opcional do contêiner HTML em que minimensagens serão exibidas

Detalhes dos métodos

createDismissableMessage

HTMLElement createDismissibleMessage(message, opt_callback)
    Cria uma mensagem que pode ser dispensada com um ícone [x] que permite aos usuários dispensar a mensagem. Quando a mensagem é dispensada, ela é removida do DOM, e a função de callback opcional, se definida, é chamada.
    Parâmetros:
      String, Object message - A mensagem como uma string HTML ou elemento DOM
      Function opt_callback - Função de callback opcional a ser chamada quando a mensagem for dispensada
    Returns:
      HTMLElement  elemento HTML da mensagem criada

createStaticMessage

HTMLElement createStaticMessage(message)
    Cria uma mensagem estática que só pode ser dispensada programaticamente (chamando dismissMessage()).
    Parâmetros:
      String, Object message - A mensagem como uma string HTML ou elemento DOM
    Retornar:
      HTMLElement  elemento HTML da mensagem criada

createTimerMessage

HTMLElement createTimerMessage(message, seconds, opt_callback)
    Cria uma mensagem exibida durante o número especificado de segundos. Quando o timer expira, a mensagem é dispensada e a função de callback opcional é executada.
    Parâmetros:
      String, Object message - A mensagem como uma string HTML ou elemento DOM
      number seconds - Número de segundos de espera antes de dispensar a mensagem
      Function opt_callback - Função de callback opcional a ser chamada quando a mensagem for dispensada
    Retornar:
      HTMLElement  elemento HTML1 HTMLElement  HTMLElement 

      ignorar mensagem

      dismissMessage(message)
        Dispensa a mensagem especificada.
        Parâmetros:
          HTMLElement message - Elemento HTML da mensagem a ser removida

      Voltar ao início

      Dispositivos da classe.Prefs

      Fornece acesso às preferências do usuário, dimensões do módulo e mensagens. Para acessar as preferências, os clientes podem criar uma instância de SKUs.Prefs e transmitir o ID do módulo deles. Exemplo:

      var prefs = new gadgets.Prefs();
      var name = prefs.getString("name");
      var lang = prefs.getLang();

      Resumo dos construtores

      gadgets.Prefs(opt_moduleId)
      Cria um novo objeto Prefs.
       

      Resumo dos métodos

       Array.<String> getArray(key)
      Recupera uma preferência como uma matriz.
       Boolean getBool(key)
      Recupera uma preferência como um booleano.
       String getCountry()
      Recebe o país atual, retornado como código ISO 3166-1 alfa-2.
       Number getFloat(key)
      Recupera uma preferência como um valor de ponto flutuante.
       Number getInt(key)
      Recupera uma preferência como um número inteiro.
       String getLang()
      Recebe o idioma atual que o gadget precisa usar na renderização, retornado como um código de idioma ISO 639-1.
       String, Number getModuleId()
      Recebe o ID do módulo da instância atual.
       String getMsg(key)
      Busca uma mensagem não formatada.
       String getString(key)
      Recupera uma preferência como uma string.
      set(key, val)
      Armazena uma preferência.
      setArray(key, val)
      Armazena uma preferência de matriz.
       

      Detalhes do construtor

      gadgets.Prefs

      gadgets.Prefs(opt_moduleId)
        Cria um novo objeto Prefs.
        Parâmetros:
          String, Number opt_moduleId - Um parâmetro opcional especificando o ID do módulo para criar preferências. Se não for fornecido, o ID do módulo padrão será usado

      Detalhes dos métodos

      getArray

      Array.<String> getArray(key)
        Recupera uma preferência como uma matriz. Os valores de UserPref que não foram declarados como listas são tratados como matrizes de um elemento.
        Parâmetros:
          String key - A preferência a ser buscada
        Retorna:
          Array.<String>  A preferência; se não for definido, uma matriz vazia

      getBool

      Boolean getBool(key)
        Recupera uma preferência como um booleano.
        Parâmetros:
          String key - A preferência a ser buscada
        Retornar:
          Boolean  A preferência; se não for definido, falso

      getCountry

      String getCountry()
        Recebe o país atual, retornado como código ISO 3166-1 alfa-2.
        Retornar:
          String  O país desta instância do módulo

      getFloat

      Number getFloat(key)
        Recupera uma preferência como um valor de ponto flutuante.
        Parâmetros:
          String key - A preferência a ser buscada
        Retornar:
          Number  A preferência; se não for definido, 0

      getInt

      Number getInt(key)
        Recupera uma preferência como um número inteiro.
        Parâmetros:
          String key - A preferência a ser buscada
        Retornar:
          Number  A preferência; se não for definido, 0

      getLang

      String getLang()
        Recebe o idioma atual que o gadget precisa usar na renderização, retornado como um código de idioma ISO 639-1.
        Retornar:
          String  O idioma desta instância do módulo

      getModuleId

      String, Number getModuleId()
        Recebe o ID do módulo da instância atual.
        Retornar:
          String, Number  O ID do módulo desta instância do módulo

      getMsg

      String getMsg(key)
        Busca uma mensagem não formatada.
        Parâmetros:
          String key - A mensagem a ser buscada
        Retornar:
          String  A mensagem

      getString

      String getString(key)
        Recupera uma preferência como uma string.
        Parâmetros:
          String key - A preferência a ser buscada
        Retornar:
          String  A preferência; se não tiver sido definida, uma string vazia

      definir

      set(key, val)
        Armazena uma preferência. Para usar essa chamada, o gadget precisa dos conjuntos de recursos.

        Observação: se o gadget precisar armazenar uma matriz, use setArray em vez desta chamada.

        Parâmetros:
          String key - O Pref para armazenar
          Object val - Os valores a serem armazenados

      setArray

      setArray(key, val)
        Armazena uma preferência de matriz. Para usar essa chamada, o gadget precisa dos conjuntos de recursos.
        Parâmetros:
          String key - O Pref para armazenar
          Array val - Os valores a serem armazenados

      Voltar ao início

      Classe gadgets.Tab

      Classe de guia para gadgets. Use o método TabSet addTab() para criar guias. Para receber objetos Tab, use os métodos TabSet getSelectedTab() ou getTabs().

      Veja também: TabSet

      Resumo dos métodos

       Function getCallback()
      Retorna a função de callback que é executada quando a guia é selecionada.
       HTMLElement getContentContainer()
      Retorna o elemento HTML em que o conteúdo da guia é renderizado.
       Number getIndex()
      Retorna o índice da guia.
       String getName()
      Retorna o rótulo da guia como uma string (pode conter HTML).
       HTMLElement getNameContainer()
      Retorna o elemento HTML que contém o rótulo da guia.
       

      Detalhes dos métodos

      getCallback

      Function getCallback()
        Retorna a função de callback que é executada quando a guia é selecionada.
        Retornar:
          Function  A função de callback da guia

      getContentContainer

      HTMLElement getContentContainer()
        Retorna o elemento HTML em que o conteúdo da guia é renderizado.
        Retornar:
          HTMLElement  O elemento HTML do contêiner de conteúdo

      getIndex

      Number getIndex()
        Retorna o índice da guia.
        Retornar:
          Number  O índice da guia

      getName

      String getName()
        Retorna o rótulo da guia como uma string (pode conter HTML).
        Retornar:
          String  O rótulo da guia

      getNameContainer

      HTMLElement getNameContainer()
        Retorna o elemento HTML que contém o rótulo da guia.
        Retornar:
          HTMLElement  O elemento HTML do rótulo da guia

      Voltar ao início

      Dispositivos de classe.TabSet

      Os gadgets de classe podem usar para fazer guias.

      Resumo dos construtores

      gadgets.TabSet(opt_moduleId, opt_defaultTab, opt_container)
      Cria um novo objeto TabSet

      Resumo dos métodos

       String addTab(tabName, opt_params)
      Adiciona uma nova guia com base nos pares de nome-valor especificados em opt_params.
      alignTabs(align, opt_offset)
      Define o alinhamento das guias.
      displayTabs(display)
      Mostra ou oculta guias e todo o conteúdo associado.
       HTMLElement getHeaderContainer()
      Retorna o elemento do contêiner dos cabeçalhos de guia.
       gadgets.Tab getSelectedTab()
      Retorna o objeto da guia selecionado no momento.
       Array.<gadgets.Tab> getTabs()
      Retorna uma matriz de todos os objetos de guia existentes.
      removeTab(tabIndex)
      Remove uma guia em tabIndex e todo seu conteúdo associado.
      setSelectedTab(tabIndex)
      Seleciona a guia no tabIndex e aciona a função de callback da guia se ela existir.
      swapTabs(tabIndex1, tabIndex2)
      Altera as posições das guias em tabIndex1 e tabIndex2.
       

      Detalhes do construtor

      gadgets.TabSet

      gadgets.TabSet(opt_moduleId, opt_defaultTab, opt_container)
        Cria um novo objeto TabSet
        Parâmetros:
          String opt_moduleId - Sufixo opcional para o ID do contêiner da guia
          String opt_defaultTab - Nome de guia opcional que especifica o nome da guia selecionada após a inicialização. Se este parâmetro for omitido, a primeira guia será selecionada por padrão
          HTMLElement opt_container - o elemento HTML 1 o elemento a cada 1

          Detalhes dos métodos

          Adicionar guia

          String addTab(tabName, opt_params)
            Adiciona uma nova guia com base nos pares de nome-valor especificados em opt_params. As propriedades a seguir são aceitas em opt_params:
            contentContainer
            Um elemento HTML atual a ser usado como contêiner de conteúdo da guia. Se omitido, a biblioteca tab cria uma.
            callback
            Uma função de callback a ser executada quando a guia for selecionada.
            dica
            Uma descrição de dica que aparece quando o usuário move o cursor do mouse sobre a guia
            index
            O índice em que a guia será inserida. Se omitido, a nova guia será anexada ao fim.
            Parâmetros:
              String tabName - Etiqueta da guia a ser criada
              Object opt_params - Objeto de parâmetro opcional
            Returns:
              String  ID do DOM do contêiner da guia

          alignTabs

          alignTabs(align, opt_offset)
            Define o alinhamento das guias. As guias são alinhadas ao centro por padrão.
            Parâmetros:
              String align - 'left', 'center', 'right'
              Number opt_offset - Parâmetro opcional para definir o número de pixels para deslocar guias da borda esquerda ou direita; o valor padrão é 3 px
          { 1

          visores

          displayTabs(display)
            Mostra ou oculta guias e todo o conteúdo associado.
            Parâmetros:
              Boolean display - Verdadeiro para exibir guias; falso para ocultar guias

          getHeaderContainer

          HTMLElement getHeaderContainer()
            Retorna o elemento do contêiner dos cabeçalhos de guia.
            Retornar:
              HTMLElement  O elemento do contêiner dos cabeçalhos de guia

          getSelectedTab

          gadgets.Tab getSelectedTab()
            Retorna o objeto de guia selecionado no momento.
            Retornar:
              gadgets.Tab  O objeto da guia selecionado no momento

          getTabs

          Array.<gadgets.Tab> getTabs()
            Retorna uma matriz de todos os objetos de guia existentes.
            Retornar:
              Array.<gadgets.Tab>  Matriz de todos os objetos de guia existentes

          remover guia

          removeTab(tabIndex)
            Remove uma guia em tabIndex e todo o conteúdo associado a ela.
            Parâmetros:
              Number tabIndex - Índice da guia que será removida

          setSelectedTab

          setSelectedTab(tabIndex)
            Seleciona a guia em tabIndex e aciona a função de callback da guia se houver. Se a guia já estiver selecionada, o retorno de chamada não será disparado.
            Parâmetros:
              Number tabIndex - Índice da guia que será selecionada

          Trocar guias

          swapTabs(tabIndex1, tabIndex2)
            Troca as posições das guias em tabIndex1 e tabIndex2. A guia selecionada não muda, e nenhuma função de callback é chamada.
            Parâmetros:
              Number tabIndex1 - Índice da primeira guia a ser trocada
              Number tabIndex2 - Índice da guia secundária para trocar

          Voltar ao início

          Dispositivos estáticos flash da classe estática

          Incorpora conteúdo do Flash nos gadgets.

          Resumo dos métodos

          <static>  Boolean embedCachedFlash()
          Injeta um arquivo Flash em cache na árvore do DOM.
          <static>  Boolean embedFlash(swfUrl, swfContainer, swfVersion, opt_params)
          Injeta um arquivo Flash na árvore do DOM.
          <static>  Number getMajorVersion()
          Detecta o Flash Player e a versão principal dele.
           

          Detalhes dos métodos

          embedCachedFlash

          <static> Boolean embedCachedFlash()
            Injeta um arquivo Flash em cache na árvore do DOM. Aceita os mesmos parâmetros que os gadgets.Flash.embedFlash.
            Retornar:
              Boolean  Se a chamada de função foi concluída com êxito

          Flash incorporado

          <static> Boolean embedFlash(swfUrl, swfContainer, swfVersion, opt_params)
            Injeta um arquivo Flash na árvore do DOM.
            Parâmetros:
              String swfUrl - URL de SWF
              String, Object swfContainer - O ID ou a referência de objeto de um elemento de contêiner HTML existente
              Number swfVersion - Versão mínima necessária do Flash Player
              Object opt_params - Um objeto opcional que pode conter qualquer parâmetro HTML válido durante a criação

          getMajorVersion

          <static> Number getMajorVersion()
            Detecta o Flash Player e a versão principal dele.
            Retornar:
              Number  A versão principal do Flash Player ou 0 se o Flash não for compatível

          Voltar ao início

          Dispositivos estáticos classe gadgets.io

          Fornece funções de recuperação de conteúdo remota.

          Resumo dos métodos

          <static>  String encodeValues(fields)
          Converte um objeto de entrada em uma string de dados codificada em URL.
          <static>  String getProxyUrl(url, opt_params)
          Recebe a versão do proxy do URL transmitido.
          <static> makeRequest(url, callback, opt_params)
          Busca o conteúdo do URL fornecido e o alimenta para a função de callback.
           

          Detalhes dos métodos

          Códigos de codificação

          <static> String encodeValues(fields)
            Converte um objeto de entrada em uma string de dados codificada em URL. (chave=valor&...)
            Parâmetros:
              Object fields - Os campos de postagem que você quer codificar
            Devolve:
              String  Os dados de postagem processados. Isso inclui um "e" comercial (&)

          getProxyUrl

          <static> String getProxyUrl(url, opt_params)
            Recebe a versão de proxy do URL transmitido.
            Parâmetros:
              String url - O URL que recebe o URL do proxy para
              Map<String, String> opt_params - Outros parâmetros opcionais para transmitir à solicitação
            Retornar:
              String  A versão de proxy do URL
          5

          MakeRequest

          <static> makeRequest(url, callback, opt_params)
            Busca conteúdo do URL fornecido e o alimenta na função de callback. Exemplo:
            var params = {};
            params[gadgets.io.RequestParameters.CONTENT_TYPE] = gadgets.io.ContentType.TEXT;
            gadgets.io.makeRequest(url, callback, params);
            

            Autorização assinada

            Se opt_params[gadgets.io.RequestParameters.AUTHORIZATION] for definido como gadgets.io.AuthorizationType.SIGNED, o contêiner precisa garantir a identidade do usuário para o servidor de destino. O contêiner faz isso fazendo o seguinte:

            1. Remoção de todos os parâmetros de solicitação com nomes que começam com oauth, xoauth ou opensocial (não diferenciam maiúsculas de minúsculas).

            2. Adicione os seguintes parâmetros à string de consulta de solicitação:

              opensocial_viewer_id
              Opcional.
              O ID do visualizador atual, que corresponde ao valor getId() no objeto da pessoa que está assistindo o conteúdo.
              opensocial_owner_id
              Obrigatório.
              O ID do proprietário atual, que corresponde ao valor getId() no objeto da pessoa do proprietário.
              open_social_url
              Obrigatório.
              O URL do aplicativo que faz a solicitação. Os contêineres podem aliases vários URLs de aplicativo para um único URL canônico de aplicativo no caso de um aplicativo alterar URLs.
              opensocial_instance_id
              Opcional.
              Um identificador opaco usado para distinguir entre várias instâncias do mesmo aplicativo em um único contêiner. Se um contêiner não permitir que várias instâncias do mesmo aplicativo coexistam, esse parâmetro poderá ser omitido. A combinação de opensocial_app_url e opensocial_instance_id identifica exclusivamente uma instância de um aplicativo em um contêiner.
              ID do app aberto em redes sociais
              Opcional.
              Um identificador opaco do aplicativo, exclusivo para um contêiner específico. Os contêineres que quiserem manter a compatibilidade com versões anteriores com a especificação opensocial-0.7 podem incluir esse parâmetro.
              xoauth_signature_publickey
              Opcional.
              Um identificador opaco da chave pública usada para assinar a solicitação. Esse parâmetro pode ser omitido por contêineres que não usam chaves públicas para assinar solicitações ou se o contêiner organiza outros meios de distribuição de chaves com o destino da solicitação.
            3. Assinatura da solicitação resultante de acordo com a seção 9 da especificação do OAuth (em inglês).

          Gerenciamento de chaves para gadgets.io.AuthorizationType.SIGNED

          Se um contêiner usar chaves públicas para assinar solicitações, ele poderá optar por usar certificados autoassinados ou certificados assinados por uma autoridade de certificação conhecida. Se um contêiner não distribuir a chave de assinatura OAuth por HTTPS, ele precisará usar um certificado assinado por uma autoridade de certificação conhecida.

          O atributo commonName do certificado precisa corresponder ao nome do host do servidor de contêiner e também ao valor do parâmetro oauth_consumer_key especificado na solicitação.

          O contêiner precisa disponibilizar a chave pública para download em um local conhecido. O local https://container-hostname/opensocial/certificates/xoauth_signature_publickeyvalue é recomendado.

          Os destinatários das solicitações assinadas precisam verificar se a assinatura na solicitação está correta e se o carimbo de data/hora da solicitação está dentro de uma janela de tempo razoável. Recomenda-se uma janela de tempo de 5 minutos antes e depois do horário atual.

          Os destinatários das solicitações assinadas podem usar os parâmetros oauth_consumer_key e xoauth_signature_publickey para detectar automaticamente quando um contêiner implanta novos certificados. Se o contêiner implantar certificados em um local conhecido, o destinatário poderá fazer o download do novo certificado automaticamente. Os destinatários que fazem o download automático de novos certificados precisam armazenar em cache os certificados resultantes.

          Se o download de um certificado de contêiner não for feito de https://container-hostname, o destinatário precisará verificar se o certificado é assinado por uma autoridade de certificação conhecida antes de confiar no certificado.

          Autorização de OAuth

          Se opt_params[gadgets.io.RequestParameters.AUTHORIZATION] estiver definido como gadgets.io.AuthorizationType.OAUTH, o contêiner precisa usar o OAuth para ter acesso ao recurso especificado na solicitação. Isso pode exigir que o gadget receba o conteúdo do usuário, direcionando o usuário para o provedor de serviços para ter acesso.

          Parâmetros adicionais

          Os seguintes parâmetros adicionais podem ser especificados em opt_params:

          gadgets.io.RequestParameters.OAUTH_SERVICE_NAME
          O apelido usado pelo gadget para fazer referência ao elemento OAuth <Service> da especificação XML. Se não for especificado, o padrão será "".
          gadgets.io.RequestParameters.OAUTH_TOKEN_NAME
          O apelido que o gadget usa para se referir a um token do OAuth que concede acesso a recursos específicos. Se não for especificado, o padrão será "quot;"". Os gadgets poderão usar vários nomes de token se tiverem acesso a vários recursos do mesmo provedor de serviços. Por exemplo, um gadget com acesso a uma lista de contatos e uma agenda pode usar um nome de token de "contacts" para usar o token da lista de contatos e uma lista de contatos de "calendar" para usar o token da agenda.
          gadgets.io.RequestParameters.OAUTH_REQUEST_TOKEN
          Um provedor de serviços pode provisionar um gadget automaticamente com um token de solicitação pré-aprovado para acesso a um recurso. O gadget pode usar esse token com o parâmetro OAUTH_REQUEST_TOKEN. Este parâmetro é opcional.
          gadgets.io.RequestParameters.OAUTH_REQUEST_TOKEN_SECRET
          O secret correspondente a um token de solicitação pré-aprovado. Este parâmetro é opcional.

          Se o OAuth for usado, o contêiner precisará executar o protocolo OAuth em nome do gadget. Se o gadget não registrar uma chave pessoal para uso com esse provedor de serviços, o contêiner poderá optar por usar uma chave de assinatura RSA padrão correspondente a um certificado conhecido para assinar solicitações. Se o contêiner usar uma chave de consumidor padrão, ele incluirá um parâmetro OAuth xoauth_app_url, que identifica o gadget que faz a solicitação.

          Parâmetro de callback

          O parâmetro de callback makeRequest() recebe um objeto JavaScript com vários campos específicos de OAuth, além dos valores normais retornados por makeRequest():

          "oauthApprovalUrl"
          Se esse valor for especificado, o usuário precisará acessar uma página externa para aprovar a solicitação de acesso aos dados do gadget. Recomendamos usar uma janela pop-up para direcionar o usuário à página externa. Depois que o usuário aprovar o acesso, o gadget poderá repetir a chamada makeRequest para recuperar os dados.
          "oauthError"
          Se esse valor for especificado, significa que ocorreu um erro relacionado ao OAuth. O valor será um de um conjunto de constantes de string que podem ser usadas para detectar erros de forma programática. As constantes são indefinidas para opensocial-0.8, mas os implementadores precisam tentar combinar um conjunto de valores constantes úteis para padrão na opensocial-0.9.
          "oauthErrorText"
          Se esse valor for especificado, significa que ocorreu um erro relacionado ao OAuth. O valor é um texto de formato livre que pode ser usado para fornecer informações de depuração para desenvolvedores de gadget.
          { /

          Voltar ao início

          Dispositivos estáticos: gadgets.io.AuthorizationType

          Usado por RequestParameters.

          Resumo dos campos

          <static> object NONE
          Sem autorização.
          <static> object OAUTH
          O contêiner usará o OAuth para autenticação.
          <static> object SIGNED
          A solicitação será assinada pelo contêiner.
           

          Detalhes do campo

          NENHUM

          <static> object NONE
            Sem autorização.

          OAUTH

          <static> object OAUTH
            O contêiner usará o OAuth para autenticação.

          Assinar

          <static> object SIGNED
            A solicitação será assinada pelo contêiner.

          Voltar ao início

          Gadgets estático.io.ContentType de classe estática

          Usado por RequestParameters.

          Resumo dos campos

          <static> object DOM
          Retorna um objeto DOM usado para buscar XML.
          <static> object FEED
          Retorna uma representação JSON de um feed RSS ou Atom.
          <static> object JSON
          Retorna um objeto JSON.
          <static> object TEXT
          Retorna o texto. Usado para buscar HTML.
           

          Detalhes do campo

          DOM

          <static> object DOM
            Retorna um objeto DOM usado para buscar XML.

          FEED

          <static> object FEED
            Retorna uma representação JSON de um feed RSS ou Atom.

          JSON

          <static> object JSON
            Retorna um objeto JSON.

          TEXT

          <static> object TEXT
            Retorna o texto. Usado para buscar HTML.

          Voltar ao início

          Dispositivos estáticos classe gadgets.io.MethodType

          Define valores para RequestParameters.METHOD.

          Resumo dos campos

          <static> object DELETE
          O suporte a contêineres para esse tipo de método é OPCIONAL.
          <static> object GET
          O tipo padrão.
          <static> object HEAD
          O suporte a contêineres para esse tipo de método é OPCIONAL.
          <static> object POST
          O suporte a contêineres para esse tipo de método é OPCIONAL.
          <static> object PUT
          O suporte a contêineres para esse tipo de método é OPCIONAL.
           

          Detalhes do campo

          EXCLUIR

          <static> object DELETE
            O suporte a contêineres para esse tipo de método é OPCIONAL.

          GET

          <static> object GET
            O tipo padrão.
          <static> object HEAD
            O suporte a contêineres para esse tipo de método é OPCIONAL.

          POST

          <static> object POST
            O suporte a contêineres para esse tipo de método é OPCIONAL.

          PUT

          <static> object PUT
            O suporte a contêineres para esse tipo de método é OPCIONAL.

          Voltar ao início

          Dispositivos estáticos: gadgets.io.ProxyUrlRequestParameters

          Usado pelo método gadgets.io.getProxyUrl().

          Resumo dos campos

          <static> object REFRESH_INTERVAL
          Tente usar o armazenamento em cache de conteúdo.
           

          Detalhes do campo

          REFRESH_INTERVAL

          <static> object REFRESH_INTERVAL
            Tente usar o armazenamento em cache de conteúdo. O intervalo de atualização é o número de segundos que queremos armazenar em cache a resposta especificada. Por padrão, os cabeçalhos HTTP serão respeitados. Se não houver cabeçalhos HTTP, esse valor será padronizado como 3600 (uma hora). Observe que as solicitações e objetos assinados com POST_DATA geralmente não são armazenados em cache.

          Voltar ao início

          Dispositivos estáticos: gadgets.io.RequestParameters

          Usado pelo método gadgets.io.makeRequest().

          Resumo dos campos

          <static> object AUTHORIZATION
          O tipo de autenticação a ser usado ao buscar o conteúdo. O padrão é AuthorizationType.NONE.
          <static> object CONTENT_TYPE
          O tipo de conteúdo que reside no URL. O padrão é ContentType.TEXT.
          <static> object GET_SUMMARIES
          Se o conteúdo for um feed, se vai buscar resumos para esse feed, o padrão será falso.
          <static> object HEADERS
          Os cabeçalhos HTTP para enviar ao URL. O padrão é nulo.
          <static> object METHOD
          O método a ser usado ao buscar o conteúdo do URL. O padrão é MethodType.GET.
          <static> object NUM_ENTRIES
          Se o conteúdo for um feed, o número de entradas a serem buscadas será o padrão 3.
          <static> object POST_DATA
          Os dados a serem enviados para o URL usando o método POST. O padrão é nulo.
           

          Detalhes do campo

          AUTORIZAÇÃO

          <static> object AUTHORIZATION
            O tipo de autenticação a ser usado ao buscar o conteúdo. O padrão é AuthorizationType.NONE. Especificado como um AuthorizationType.

          CONTENT_TYPE

          <static> object CONTENT_TYPE
            O tipo de conteúdo que reside no URL. O padrão é ContentType.TEXT. Especificado como um ContentType.

          GET_SUMMARIES

          <static> object GET_SUMMARIES
            Se o conteúdo for um feed, se vai buscar resumos para esse feed, o padrão será falso. Especificado como um Boolean.

          CAMINHOS

          <static> object HEADERS
            Os cabeçalhos HTTP para enviar ao URL padrão: nulo. Especificado como um Map.<String,String>.

          MÉTODO

          <static> object METHOD
            O método a ser usado ao buscar conteúdo do URL. O padrão é MethodType.GET. Os valores válidos são especificados por MethodType.

          NUM_ENTRIES

          <static> object NUM_ENTRIES
            Se o conteúdo for um feed, o número de entradas a serem buscadas será usado como padrão. Especificado como um Number.

          POST_DATA

          <static> object POST_DATA
            Os dados a serem enviados para o URL usando o método POST. O padrão é nulo. Especificado como um String.

          Voltar ao início

          Gadgets estáticos

          Fornece operações para traduzir objetos de e para JSON.

          Resumo dos métodos

          <static>  Object parse(text)
          Analisa uma string JSON, produzindo um valor JavaScript.
          <static>  String stringify(v)
          Converte um valor de JavaScript em uma string JSON.
           

          Detalhes dos métodos

          parse

          <static> Object parse(text)
            Analisa uma string JSON, produzindo um valor JavaScript.
            Parâmetros:
              String text - a string a ser transformada em um objeto. Geralmente, o resultado de uma chamada de stringify anterior
            Retornar:
              Object  O objeto analisado do texto transmitido; false se ocorreu um erro

          Stringify

          <static> String stringify(v)
            Converte um valor de JavaScript em uma string JSON.
            Parâmetros:
              Object v - O objeto a ser convertido
            Retornar:
              String  O JSON equivalente

          Voltar ao início

          Gadgets.pubsub de classe estática

          Fornece operações para publicar e se inscrever em canais de mensagens.

          Resumo dos métodos

          <static> publish(channelName, message)
          Publica uma mensagem do tipo string em um canal.
          <static> subscribe(channelName, callback)
          Inscreve um gadget em um canal de mensagens.
          <static> unsubscribe(channelName)
          Cancela a inscrição do gadget em um canal de mensagens.
           

          Detalhes dos métodos

          publish

          <static> publish(channelName, message)
            Publica uma mensagem do tipo string em um canal.
            Parâmetros:
              String channelName - O nome do canal
              String message - A mensagem a ser publicada

          fazer inscrição

          <static> subscribe(channelName, callback)
            Inscrever um gadget em um canal de mensagens.
            Parâmetros:
              String channelName - O nome do canal
              Function callback - Uma função que será chamada com as mensagens do canal

          cancelar a inscrição

          <static> unsubscribe(channelName)
            Cancela a inscrição do gadget em um canal de mensagens.
            Parâmetros:
              String channelName - O nome do canal

          Voltar ao início

          Dispositivos estáticos, gadgets.rpc

          Fornece operações para fazer chamadas de procedimento remoto para comunicação do gadget para contêiner, do contêiner para o gadget e do gadget para o gadget.

          Resumo dos métodos

          <static> call(targetId, serviceName, callback, var_args)
          Chame um serviço de RPC.
          <static> register(serviceName, handler)
          Registra um serviço de RPC.
          <static> registerDefault(handler)
          Registra um gerenciador de serviço padrão para processar todas as chamadas de procedimento remoto desconhecido, que falham silenciosamente por padrão.
          <static> unregister(serviceName)
          Cancela o registro de um serviço de RPC.
          <static> unregisterDefault()
          Cancela o registro do gerenciador de serviço padrão
           

          Detalhes dos métodos

          call

          <static> call(targetId, serviceName, callback, var_args)
            Chama um serviço de RPC.
            Parâmetros:
              String targetId - ID do provedor de serviços de RPC; vazio se estiver chamando o contêiner pai
              String serviceName - Nome do serviço a ser chamado
              Function, null callback - Função de callback (se houver) para processar o valor de retorno da solicitação de RPC
              * var_args - Parâmetros da solicitação de RPC
          {1 }}

          fazer inscrição

          <static> register(serviceName, handler)
            Registra um serviço de RPC.
            Parâmetros:
              String serviceName - Nome do serviço a ser registrado
              Function handler - Gerenciador de serviços

          defaultDefault

          <static> registerDefault(handler)
            Registra um gerenciador de serviço padrão para processar todas as chamadas de procedimento remoto desconhecido, que falham silenciosamente por padrão.
            Parâmetros:
              Function handler - Gerenciador de serviços

          unregister

          <static> unregister(serviceName)
            Cancela o registro de um serviço de RPC.
            Parâmetros:
              String serviceName - Nome do serviço para cancelar a inscrição

          DefaultDefault

          <static> unregisterDefault()
            Cancela o registro do gerenciador de serviços padrão. As próximas chamadas de procedimento remoto desconhecido falharão silenciosamente.

          Voltar ao início

          Gadgets.skins de classe estática

          Fornece operações para receber informações de exibição sobre o tema em exibição.

          Resumo dos métodos

          <static>  String getProperty(propertyKey)
          Busca a propriedade de exibição mapeada para a chave especificada.
           

          Detalhes dos métodos

          getProperty

          <static> String getProperty(propertyKey)
            Busca a propriedade de exibição mapeada para a chave especificada.
            Parâmetros:
              String propertyKey - A chave para a qual os dados serão obtidos. As chaves são definidas em gadgets.skins.Property
            Retornar:
              String  Os dados

          Voltar ao início

          Gadgets estáticos.skins.Property

          Todos os valores de exibição que podem ser buscados e usados na IU dos gadgets. Essas são as chaves compatíveis com o método SKUs.skins.getProperty().

          Resumo dos campos

          <static> object ANCHOR_COLOR
          A cor que as tags âncora precisam usar.
          <static> object BG_COLOR
          É a cor do plano de fundo do gadget.
          <static> object BG_IMAGE
          Uma imagem para usar em segundo plano no gadget.
          <static> object FONT_COLOR
          A cor em que a fonte principal será renderizada.
           

          Detalhes do campo

          ANCHOR_COLOR

          <static> object ANCHOR_COLOR
            É a cor que as tags âncora precisam usar.

          COR BG

          <static> object BG_COLOR
            A cor do plano de fundo do gadget.

          IMAGEM_BG

          <static> object BG_IMAGE
            É uma imagem a ser usada em segundo plano no gadget.

          FONT_COR

          <static> object FONT_COLOR
            A cor em que a fonte principal será renderizada.

          Voltar ao início

          Gadgets estáticos.

          Fornece funções utilitárias de uso geral

          Resumo dos métodos

          <static>  String escapeString(str)
          Escapada a entrada usando entidades HTML para torná-las mais seguras.
          <static>  Object getFeatureParameters(feature)
          Retorna o valor dos parâmetros desse recurso.
          <static>  Boolean hasFeature(feature)
          Retorna se o recurso especificado é compatível.
          <static> registerOnLoadHandler(callback)
          Registra um gerenciador de carregamento, uma função que é executada quando o gadget é carregado.
          <static>  String unescapeString(str)
          Reverte escapeString

          Detalhes dos métodos

          String de escape

          <static> String escapeString(str)
            Escape da entrada usando entidades HTML para torná-la mais segura. Os seguintes caracteres são afetados:
            • nova linha (\n, ponto de código 10 Unicode)
            • retorno de carro (armeabi, Unicode 13)
            • aspas duplas (", Unicode 34)
            • E comercial (&, Unicode 38)
            • aspas simples (', Unicode 39)
            • colchete angular esquerdo (<, Unicode 60)
            • colchete angular direito (>, Unicode 62)
            • barra invertida (\, Unicode 92)
            • separador de linhas (Unicode 8232)
            • separador de parágrafo (Unicode 8233)
            Parâmetros:
              String str - A string a ser removida
            Retornar:
              String  A string com escape

          getFeatureParameters

          <static> Object getFeatureParameters(feature)
            Retorna o valor dos parâmetros desse recurso. Um gadget especifica parâmetros usando o subelemento <Param> do elemento <Requires> ou <Optional>.
            Parâmetros:
              String feature - O recurso que receberá parâmetros para
            Retornar:
              Object  Os parâmetros do recurso fornecido ou nulos

          hasFeature

          <static> Boolean hasFeature(feature)
            Retorna se o recurso especificado for compatível.
            Parâmetros:
              String feature - O recurso a ser testado
            Retornar:
              Boolean  Verdadeiro se o recurso for compatível

          registerOnLoadHandler

          <static> registerOnLoadHandler(callback)
            Registra um gerenciador de carregamento, uma função que é executada quando o gadget é carregado.
            Parâmetros:
              Function callback - O gerenciador a ser executado

          string de escape

          <static> String unescapeString(str)
            Reverse escape
            Parâmetros:
              String str - a string a ser removida.
            Retornar:
              String  A string sem escape

          Voltar ao início

          gadgets.views da classe estática

          Fornece operações para lidar com visualizações.

          Veja também: gadgets.views.View

          Resumo dos métodos

          <static>  String bind(urlTemplate, environment)
          Vincula um modelo de URL com variáveis no ambiente transmitido para produzir uma string de URL.
          <static>  gadgets.views.View getCurrentView()
          Retorna a visualização atual.
          <static>  Map.<String, String> getParams()
          Retorna os parâmetros transmitidos para este gadget para a visualização.
          <static>  Map<gadgets.views.ViewType, String, gadgets.views.View> getSupportedViews()
          Retorna um mapa de todas as visualizações compatíveis.
          <static> requestNavigateTo(view, opt_params, opt_ownerId)
          Tentar acessar este gadget em uma visualização diferente.
           

          Detalhes dos métodos

          vincular

          <static> String bind(urlTemplate, environment)
            Vincula um modelo de URL com variáveis no ambiente transmitido para produzir uma string de URL.

            Veja também: View.getUrlTemplate()

            Parâmetros:
              urlTemplate - Um modelo de URL para uma visualização de contêiner
              environment - Um conjunto de variáveis nomeadas (por exemplo, [OWNER | PATH | PARAMS | NAME]) da string de tipo.
            Retornar:
              String  Uma string de URL

          Visualização simples

          <static> gadgets.views.View getCurrentView()
            Retorna a visualização atual.
            Retornar:
              gadgets.views.View  A visualização atual

          getParams

          <static> Map.<String, String> getParams()
            Retorna os parâmetros transmitidos para este gadget para a visualização. Não inclui todos os parâmetros de URL, apenas aqueles transmitidos para gadgets.views.requestNavegarTo.
            Retornar:
              Map.<String, String>  O mapa de parâmetro

          getSupportedViews

          <static> Map<gadgets.views.ViewType, String, gadgets.views.View> getSupportedViews()
            Retorna um mapa de todas as visualizações compatíveis. Registra cada gadgets.view.View pelo nome.
            Retornar:
              Map<gadgets.views.ViewType, String, gadgets.views.View>  Todas as visualizações compatíveis, codificadas pelo atributo de nome.

          requestNavigationTo

          <static> requestNavigateTo(view, opt_params, opt_ownerId)
            Tentar acessar este gadget em uma visualização diferente. Se o contêiner for compatível com parâmetros, ele transmitirá os parâmetros opcionais para o gadget na nova visualização.
            Parâmetros:
              gadgets.views.View view - A visualização a ser acessada
              Map.<String, String> opt_params - Parâmetros que serão transmitidos para o gadget após a navegação na superfície
              String opt_ownerId - O ID do proprietário da página a ser acessada; assume o padrão do proprietário atual
          /} {

          Voltar ao início

          Classe gadgets.views.View

          Interface de base para todos os objetos de visualização.

          Resumo dos métodos

           String bind(environment)
          Vincula o modelo de URL da visualização com variáveis no ambiente transmitido para produzir uma string de URL.
           gadgets.views.ViewType, String getName()
          Retorna o nome desta visualização.
           String getUrlTemplate()
          Retorna um modelo de URI de string em conformidade com o rascunho de especificação IETF com variáveis para substituição.
           boolean isOnlyVisibleGadget()
          Retornará verdadeiro se o gadget for o único gadget visível nesta visualização.
           

          Detalhes dos métodos

          vincular

          String bind(environment)
            Vincula o modelo de URL da visualização com variáveis no ambiente transmitido para produzir uma string de URL.

            Veja também: getUrlTemplate()

            Parâmetros:
              environment - um conjunto de variáveis nomeadas (por exemplo, [OWNER | PATH | PARAMS | NAME]) da string de tipo.
            Retornar:
              String  Uma string de URL

          getName

          gadgets.views.ViewType, String getName()
            Retorna o nome desta visualização.
            Retornar:
              gadgets.views.ViewType, String  O nome da visualização, geralmente especificado como um gadgets.views.ViewType

          getUrlTemplate

          String getUrlTemplate()
            Retorna um modelo de URI de string em conformidade com o rascunho de especificação IETF com variáveis para substituição.

            Quatro variáveis são compatíveis:

            nome
            O nome ou ID do aplicativo
            proprietário
            O ID do proprietário da página
            caminho
            Uma matriz de etapas de caminho
            params
            Matriz ou matriz associativa[param1,value1,param2,value2,...]

            Exemplo

            Veja duas strings válidas de modelo de URL:

            http://container.com/{-list|/|name,owner,path}?{-join|&|params}
            http://container.com/apps/{name}/{owner}{-prefix|/|path}{-opt|?os_|params}{-join|&os_|params} 
            

            Veja alguns parâmetros:

            { 
              name : 'Wilma',
              owner : 'Betty',
              path : ['dino','car'], 
              params = { a : 'Barney', b : 'Fred'}
            }

            Com esses parâmetros, os dois exemplos de string de modelo de URL são resolvidos com os seguintes URLs:

            http://container.com/Wilma/Betty/dino/car?a=Barney&b=Fred
            http://container.com/apps/Wilma/Betty/dino/car?os_a=Barney&os_b=Fred
            

            Veja também: bind()

            Retornar:
              String  Um modelo que pode ser usado para construir URLs para navegar até esta visualização

          Atributo isOnlyVisible

          boolean isOnlyVisibleGadget()
            Retorna verdadeiro se o gadget for o único gadget visível nesta visualização. Em uma página de tela ou no modo "Maximizar", isso provavelmente é verdadeiro. Em uma página de perfil ou no modo de painel, provavelmente é falso.
            Retornar:
              boolean  Verdadeiro se o gadget for o único gadget visível. Caso contrário, falso

          Voltar ao início

          Dispositivos estáticos: gadgets.views.ViewType

          Usado por Views.

          Resumo dos campos

          <static> object CANVAS
          Uma visualização em que o gadget é exibido em um modo muito grande.
          <static> object HOME
          Uma visualização em que o gadget é exibido em uma área pequena, geralmente em uma página com outros gadgets.
          <static> object PREVIEW
          Uma visualização de demonstração do gadget.
          <static> object PROFILE
          Uma visualização em que o gadget é exibido em uma área pequena, geralmente em uma página com outros gadgets.
           

          Detalhes do campo

          CANVAS

          <static> object CANVAS
            Uma visualização em que o gadget é exibido em um modo muito grande. Normalmente, é o conteúdo principal da página. O espectador nem sempre é igual ao proprietário.

          TELA INICIAL

          <static> object HOME
            Uma visualização em que o gadget é exibido em uma área pequena, geralmente em uma página com outros gadgets. Normalmente, o espectador é o mesmo que o proprietário.

          PRÉVIA

          <static> object PREVIEW
            Uma visualização de demonstração do gadget. Nessa visualização, o proprietário e o leitor não são conhecidos.

          PERFIL

          <static> object PROFILE
            Uma visualização em que o gadget é exibido em uma área pequena, geralmente em uma página com outros gadgets. O espectador nem sempre é igual ao proprietário.

          Voltar ao início

          Gadgets.window de classe estática

          Fornece operações para acessar informações e modificar a janela em que o gadget é colocado.

          Resumo dos métodos

          <static> adjustHeight(opt_height)
          Ajusta a altura do gadget.
          <static>  Object getViewportDimensions()
          Detecta as dimensões internas de um frame.
          <static> setTitle(title)
          Define o título do gadget.
           

          Detalhes dos métodos

          ajuste de altura

          <static> adjustHeight(opt_height)
            Ajusta a altura do gadget.
            Parâmetros:
              Number opt_height - Uma altura opcional em pixels; se não for especificado, tentará encaixar o gadget no conteúdo

          getViewportDimension

          <static> Object getViewportDimensions()
            Retornar:
              Object  Um objeto com propriedades de largura e altura

          setTitle

          <static> setTitle(title)
            Define o título do gadget.
            Parâmetros:
              String title - O título preferencial

          Voltar ao início