Riferimento JavaScript per i gadget

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Questo documento descrive le classi e i metodi nello spazio dei nomi gadgets.*, alcuni dei quali sono specifici per funzionalità. Per informazioni sull'inclusione di funzionalità, consulta la Specifica dei gadget.

Convenzioni di tipo

Questo documento utilizza le seguenti convenzioni per i tipi:

Array<T&GT; oppure Array&<T&GT;
Un array riempito con solo oggetti di tipo T. Questa convenzione è simile ai generici Java.
Map<K, V&GT; oppure Map.<K, V&GT;
Un oggetto JavaScript con chiavi di tipo K mappate a valori di tipo V. Di nuovo, questa convenzione è simile ai generici Java. Viene spesso utilizzato per le variabili opt_params.
static
Un tipo contrassegnato con classe statica non ha un costruttore pubblico o privato. In altre parole, il tipo è uno spazio dei nomi, non una classe che è possibile creare un'istanza per creare oggetti. Anche i campi e le funzioni di questo tipo sono contrassegnati come statici.
Booleano
Un valore booleano (non un oggetto Boolean).
Stringa
Un valore di stringa (non un oggetto String).

Torna all'inizio

Gadget Gadget del corso

Classe MiniMessage, utilizzata per creare messaggi che verranno mostrati all'utente all'interno del gadget. Casi d'uso tipici:

  • Messaggi di stato: caricamento, salvataggio e così via
  • Messaggi promozionali: nuove funzionalità, nuovi gadget e così via.
  • Messaggi di debug/errore: input errato, connessione non riuscita al server e così via.

Riepilogo del costruttore

gadgets.MiniMessage(opt_moduleId, opt_container)
Crea un minimessaggio.
 

Riepilogo metodo

 HTMLElement createDismissibleMessage(message, opt_callback)
Crea un messaggio ignorabile con l'icona [x] che consente agli utenti di ignorarlo.
 HTMLElement createStaticMessage(message)
Crea un messaggio statico che può essere ignorato solo in modo programmatico (chiamando ignoraMessage()).
 HTMLElement createTimerMessage(message, seconds, opt_callback)
Crea un messaggio che viene visualizzato per il numero di secondi specificato.
dismissMessage(message)
Ignora il messaggio specificato.
 

Dettaglio costruttore

Gadget.MiniMessage

gadgets.MiniMessage(opt_moduleId, opt_container)
    Crea un minimessaggio.
    Parametri:
      String opt_moduleId - ID modulo facoltativo
      HTMLElement opt_container - Elemento facoltativo di container HTML in cui verranno visualizzati i minimessaggi

Dettaglio metodo

createIgnoraibleMessage

HTMLElement createDismissibleMessage(message, opt_callback)
    Crea un messaggio ignorabile con un'icona [x] che consente agli utenti di ignorarlo. Quando il messaggio viene ignorato, viene rimosso dal DOM e viene chiamata la funzione di callback facoltativa, se definita.
    Parametri:
      String, Object message - Il messaggio come stringa HTML o elemento DOM
      Function opt_callback - Funzione facoltativa di callback da chiamare quando il messaggio viene ignorato
    Restituisce:
      HTMLElement  Elemento HTML del messaggio creato
{/

createStaticMessage

HTMLElement createStaticMessage(message)
    Crea un messaggio statico che può essere ignorato solo in modo programmatico (chiamando il messaggio IgnoraMessage()).
    Parametri:
      String, Object message - Il messaggio come stringa HTML o elemento DOM
    Restituisce:
      HTMLElement  Elemento HTML del messaggio creato

createTimerMessage

HTMLElement createTimerMessage(message, seconds, opt_callback)
    Crea un messaggio che viene visualizzato per il numero di secondi specificato. Alla scadenza del timer, il messaggio viene ignorato e viene eseguita la funzione di callback facoltativa.
    Parametri:
      String, Object message - Il messaggio come stringa HTML o elemento DOM
      number seconds - Numero di secondi da attendere prima di ignorare il messaggio
      Function opt_callback - Funzione facoltativa di callback da chiamare quando il messaggio viene ignorato
    Restituisce:
      HTMLElement  elemento creato

      IgnoraMessaggio

      dismissMessage(message)
        Ignora il messaggio specificato.
        Parametri:
          HTMLElement message - Elemento HTML del messaggio da rimuovere

      Torna all'inizio

      Gadget gadget del corso

      Fornisce l'accesso alle preferenze dell'utente, alle dimensioni del modulo e ai messaggi. I client possono accedere alle proprie preferenze costruendo un'istanza di gadgets.Prefs e trasmettendo il proprio ID modulo. Esempio:

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

      Riepilogo del costruttore

      gadgets.Prefs(opt_moduleId)
      Crea un nuovo oggetto Prefs.
       

      Riepilogo metodo

       Array.<String> getArray(key)
      Recupera una preferenza come array.
       Boolean getBool(key)
      Recupera una preferenza come booleano.
       String getCountry()
      Recupera il paese corrente, restituito come codice ISO 3166-1 alpha-2.
       Number getFloat(key)
      Recupera una preferenza come valore con virgola mobile.
       Number getInt(key)
      Recupera una preferenza come numero intero.
       String getLang()
      Recupera la lingua corrente che il gadget deve utilizzare durante il rendering, restituita come codice lingua ISO 639-1.
       String, Number getModuleId()
      Recupera l'ID modulo per l'istanza corrente.
       String getMsg(key)
      Recupera un messaggio non formattato.
       String getString(key)
      Recupera una preferenza come stringa.
      set(key, val)
      Memorizza una preferenza.
      setArray(key, val)
      Archivia una preferenza di matrice.
       

      Dettaglio costruttore

      gadget.Prefs

      gadgets.Prefs(opt_moduleId)
        Crea un nuovo oggetto Prefs.
        Parametri:
          String, Number opt_moduleId - Parametro facoltativo che specifica l'ID modulo per cui creare i preferiti; se non viene fornito, viene utilizzato l'ID modulo predefinito

      Dettaglio metodo

      getArray

      Array.<String> getArray(key)
        Recupera una preferenza come array. I valori UserPref che non sono stati dichiarati come elenchi vengono trattati come array di un elemento.
        Parametri:
          String key - La preferenza di recupero
        Restituisce:
          Array.<String>  La preferenza; se non è impostata, viene utilizzata una matrice vuota

      GetBool

      Boolean getBool(key)
        Recupera una preferenza come booleano.
        Parametri:
          String key - La preferenza di recupero
        Restituisce:
          Boolean  La preferenza; se non è impostata su false

      getCountry

      String getCountry()
        Recupera il paese corrente, restituito come codice ISO 3166-1 alpha-2.
        Restituisce:
          String  Il paese di questa istanza del modulo

      getFloat

      Number getFloat(key)
        Recupera una preferenza come valore in virgola mobile.
        Parametri:
          String key - La preferenza di recupero
        Restituisce:
          Number  La preferenza; se non viene impostata, 0

      getInt

      Number getInt(key)
        Recupera una preferenza come numero intero.
        Parametri:
          String key - La preferenza di recupero
        Restituisce:
          Number  La preferenza; se non viene impostata, 0

      GetLang

      String getLang()
        Recupera la lingua corrente che il gadget deve utilizzare durante il rendering, restituito come codice della lingua ISO 639-1.
        Restituisce:
          String  La lingua di questa istanza del modulo

      ID modulo

      String, Number getModuleId()
        Recupera l'ID modulo per l'istanza corrente.
        Restituisce:
          String, Number  L'ID modulo di questa istanza di modulo

      getMsg

      String getMsg(key)
        Consente di recuperare un messaggio non formattato.
        Parametri:
          String key - Il messaggio da recuperare
        Restituisce:
          String  Il messaggio

      getString

      String getString(key)
        Recupera una preferenza come stringa.
        Parametri:
          String key - La preferenza di recupero
        Restituisce:
          String  La preferenza; se non è impostata, una stringa vuota

      imposta

      set(key, val)
        Archivia una preferenza. Per utilizzare questa chiamata, il gadget deve richiedere la funzionalità setprefs.

        Nota: se il gadget deve archiviare un Array, deve utilizzare setArray invece di questa chiamata.

        Parametri:
          String key - La preferenza da memorizzare
          Object val - I valori da archiviare

      setArray

      setArray(key, val)
        Archivia una preferenza di matrice. Per utilizzare questa chiamata, il gadget deve richiedere la funzionalità setprefs.
        Parametri:
          String key - La preferenza da memorizzare
          Array val - I valori da archiviare

      Torna all'inizio

      Gadget gadget del corso

      Classe scheda per i gadget. Le schede vengono create utilizzando il metodo TabSet addTab(). Per ottenere oggetti Tab, utilizza i metodi TabSet getSelectedTab() o getTabs().

      Vedi anche: TabSet

      Riepilogo metodo

       Function getCallback()
      Restituisce la funzione di callback che viene eseguita quando è selezionata la scheda.
       HTMLElement getContentContainer()
      Restituisce l'elemento HTML in cui vengono visualizzati i contenuti della scheda.
       Number getIndex()
      Restituisce l'indice della scheda.
       String getName()
      Restituisce l'etichetta della scheda come stringa (potrebbe contenere HTML).
       HTMLElement getNameContainer()
      Restituisce l'elemento HTML che contiene l'etichetta della scheda.
       

      Dettaglio metodo

      getCallback

      Function getCallback()
        Restituisce la funzione di callback che viene eseguita quando è selezionata la scheda.
        Restituisce:
          Function  La funzione di callback della scheda

      getContentContainer

      HTMLElement getContentContainer()
        Restituisce l'elemento HTML in cui viene visualizzato il contenuto della scheda.
        Restituisce:
          HTMLElement  L'elemento HTML del contenitore di contenuti

      getindex

      Number getIndex()
        Restituisce l'indice della scheda.
        Restituisce:
          Number  L'indice della scheda

      getName

      String getName()
        Restituisce l'etichetta della scheda come stringa (potrebbe contenere HTML).
        Restituisce:
          String  L'etichetta della scheda

      getNameContainer

      HTMLElement getNameContainer()
        Restituisce l'elemento HTML che contiene l'etichetta della scheda.
        Restituisce:
          HTMLElement  L'elemento HTML dell'etichetta della scheda

      Torna all'inizio

      Gadget Gadget della classe

      I gadget del corso possono essere utilizzati per creare schede.

      Riepilogo del costruttore

      gadgets.TabSet(opt_moduleId, opt_defaultTab, opt_container)
      Crea un nuovo oggetto TabSet

      Riepilogo metodo

       String addTab(tabName, opt_params)
      Aggiunge una nuova scheda in base alle coppie nome-valore specificate in opt_params.
      alignTabs(align, opt_offset)
      Imposta l'allineamento delle schede.
      displayTabs(display)
      Mostra o nasconde le schede e tutti i contenuti associati.
       HTMLElement getHeaderContainer()
      Restituisce l'elemento del contenitore delle intestazioni della scheda.
       gadgets.Tab getSelectedTab()
      Restituisce l'oggetto scheda attualmente selezionato.
       Array.<gadgets.Tab> getTabs()
      Restituisce un array di tutti gli oggetti tab esistenti.
      removeTab(tabIndex)
      Rimuove una scheda in tabIndex e tutti i contenuti associati.
      setSelectedTab(tabIndex)
      Seleziona la scheda in Tabindex e attiva la funzione di callback della scheda, se esiste.
      swapTabs(tabIndex1, tabIndex2)
      Sostituisce le posizioni delle schede in tabIndex1 e tabIndex2.
       

      Dettaglio costruttore

      gadget.TabSet

      gadgets.TabSet(opt_moduleId, opt_defaultTab, opt_container)
        Crea un nuovo oggetto TabSet
        Parametri:
          String opt_moduleId - Suffisso facoltativo per l'ID del contenitore di schede
          String opt_defaultTab - Nome della scheda facoltativo che specifica il nome della scheda selezionata dopo l'inizializzazione; se questo parametro viene omesso, la prima scheda viene selezionata per impostazione predefinita
          HTMLElement opt_container 1

          Dettaglio metodo

          addTab

          String addTab(tabName, opt_params)
            Aggiunge una nuova scheda basata sulle coppie nome-valore specificate in opt_params. Le seguenti proprietà sono supportate in opt_params:
            Container contenuti
            Un elemento HTML esistente da utilizzare come contenitore dei contenuti della scheda. Se omesso, la raccolta di schede ne crea una.
            callback
            Una funzione di callback da eseguire quando è selezionata la scheda.
            descrizione comando
            Una descrizione comando che viene visualizzata quando l'utente sposta il cursore del mouse sulla scheda.
            index
            L'indice in cui inserire la scheda. Se omessa, la nuova scheda viene aggiunta alla fine.
            Parametri:
              String tabName - Etichetta della scheda da creare
              Object opt_params - Oggetto parametro facoltativo
            Restituisce:
              String  ID DOM del contenitore di schede
          5

          allineaTab

          alignTabs(align, opt_offset)
            Consente di impostare l'allineamento delle schede. Le schede sono allineate al centro per impostazione predefinita.
            Parametri:
              String align - 'left', 'center' o 'right'
              Number opt_offset - Parametro facoltativo per impostare il numero di pixel per spostare le schede dal bordo sinistro o destro; il valore predefinito è 3px

          DisplayTab

          displayTabs(display)
            Mostra o nasconde le schede e tutti i contenuti associati.
            Parametri:
              Boolean display - True per mostrare le schede; false per nascondere le schede

          getHeaderContainer

          HTMLElement getHeaderContainer()
            Restituisce l'elemento container della scheda delle intestazioni.
            Restituisce:
              HTMLElement  L'elemento contenitore delle intestazioni di scheda

          getSelectedTab

          gadgets.Tab getSelectedTab()
            Restituisce l'oggetto scheda attualmente selezionato.
            Restituisce:
              gadgets.Tab  L'oggetto scheda attualmente selezionato

          gettab

          Array.<gadgets.Tab> getTabs()
            Restituisce un array di tutti gli oggetti tab esistenti.
            Restituisce:
              Array.<gadgets.Tab>  Array di tutti gli oggetti tab esistenti

          rimuoviTab

          removeTab(tabIndex)
            Rimuove una scheda in tabIndex e tutti i contenuti associati.
            Parametri:
              Number tabIndex - Indice della scheda da rimuovere

          setSelectedTab

          setSelectedTab(tabIndex)
            Seleziona la scheda in tabIndex e attiva la funzione di callback della scheda, se esiste. Se la scheda è già selezionata, il callback non viene attivato.
            Parametri:
              Number tabIndex - Indice della scheda da selezionare

          scambioTab

          swapTabs(tabIndex1, tabIndex2)
            Consente di cambiare la posizione delle schede in tabIndex1 e tabIndex2. La scheda selezionata non cambia e non vengono chiamate funzioni di callback.
            Parametri:
              Number tabIndex1 - Indice della prima scheda da scambiare
              Number tabIndex2 - Indice della scheda del secondo da scambiare

          Torna all'inizio

          Static Class Gadget.Flash

          Incorpora contenuti Flash nei gadget.

          Riepilogo metodo

          <static>  Boolean embedCachedFlash()
          Inserisci un file Flash memorizzato nella cache nell'albero DOM.
          <static>  Boolean embedFlash(swfUrl, swfContainer, swfVersion, opt_params)
          Inserisci un file Flash nell'albero DOM.
          <static>  Number getMajorVersion()
          Rileva Flash Player e la versione principale.
           

          Dettaglio metodo

          incorporatiCachedFlash

          <static> Boolean embedCachedFlash()
            Inserisci un file Flash memorizzato nella cache nell'albero DOM. Accetta gli stessi parametri di gadget.flash.embedFlash.
            Restituisce:
              Boolean  Se la chiamata funzione è stata completata

          Incorpora Flash

          <static> Boolean embedFlash(swfUrl, swfContainer, swfVersion, opt_params)
            Inserisci un file Flash nell'albero DOM.
            Parametri:
              String swfUrl - URL SWF
              String, Object swfContainer - L'ID o il riferimento oggetto di un elemento contenitore HTML esistente
              Number swfVersion - È richiesta la versione minima di Flash Player
              Object opt_params - Un oggetto facoltativo che può contenere qualsiasi parametro HTML valido; tutti gli attributi verranno trasmessi al filmato Flash durante la creazione
          1
            1
              1

              Versione getMajor

              <static> Number getMajorVersion()
                Rileva Flash Player e la versione principale.
                Restituisce:
                  Number  La versione principale di Flash Player o 0 se Flash non è supportato

              Torna all'inizio

              Static Class Gadget.io

              Fornisce funzioni di recupero dei contenuti da remoto.

              Riepilogo metodo

              <static>  String encodeValues(fields)
              Converte un oggetto di input in una stringa di dati con codifica URL.
              <static>  String getProxyUrl(url, opt_params)
              Recupera la versione proxy dell'URL trasmesso.
              <static> makeRequest(url, callback, opt_params)
              Recupera i contenuti dall'URL fornito e li inserisce nella funzione di callback.
               

              Dettaglio metodo

              encodeValues

              <static> String encodeValues(fields)
                Converte un oggetto di input in una stringa di dati con codifica URL. (chiave=valore&...)
                Parametri:
                  Object fields - I campi del post che vuoi codificare
                Restituisce:
                  String  I dati sul post elaborati; include una e commerciale (&)

              getProxyUrl

              <static> String getProxyUrl(url, opt_params)
                Visualizza la versione proxy dell'URL trasmesso.
                Parametri:
                  String url - L'URL per ottenere l'URL proxy per
                  Map<String, String> opt_params - Ulteriori parametri facoltativi da passare alla richiesta
                Restituisce:
                  String  La versione inviata tramite proxy dell'URL

              makeRequest

              <static> makeRequest(url, callback, opt_params)
                Recupera i contenuti dall'URL fornito e li inserisce nella funzione di callback. Esempio:
                var params = {};
                params[gadgets.io.RequestParameters.CONTENT_TYPE] = gadgets.io.ContentType.TEXT;
                gadgets.io.makeRequest(url, callback, params);
                

                Autorizzazione firmata

                Se opt_params[gadgets.io.RequestParameters.AUTHORIZATION] è impostato su gadgets.io.AuthorizationType.SIGNED, il container deve garantire l'identità dell'utente al server di destinazione. Il container esegue questa operazione:

                1. Rimozione di eventuali parametri di richiesta con nomi che iniziano con oauth, xoauth o opensocial (senza distinzione tra maiuscole e minuscole).

                2. Aggiunta dei seguenti parametri alla stringa di query della richiesta:

                  opensocial_viewer_id [id_social_spettatore]
                  Facoltativo.
                  L'ID del visualizzatore corrente, che corrisponde al valore getId() nell'oggetto persona dello spettatore.
                  opensocial_owner_id
                  Obbligatorio.
                  L'ID dell'attuale proprietario, che corrisponde al valore getId() nell'oggetto persona del proprietario.
                  opensocial_app_url
                  Obbligatorio.
                  L'URL dell'applicazione che effettua la richiesta. I container possono aggiungere alias a più URL dell'applicazione a un singolo URL dell'applicazione canonica nel caso in cui un'applicazione modifichi gli URL.
                  opensocial_instance_id
                  Facoltativo.
                  Un identificatore opaco utilizzato per distinguere tra più istanze della stessa applicazione in un singolo container. Se un container non consente la coesistenza di più istanze della stessa applicazione, questo parametro potrebbe essere omesso. La combinazione di opensocial_app_url e opensocial_instance_id identifica in modo univoco un'istanza di un'applicazione in un container.
                  opensocial_app_id
                  Facoltativo.
                  Un identificatore opaco per l'applicazione, univoco per un determinato container. I container che vogliono mantenere la compatibilità con le versioni precedenti della specifica opensocial-0.7 possono includere questo parametro.
                  xoauth_signature_publickey
                  Facoltativo.
                  Un identificatore opaco per la chiave pubblica utilizzata per firmare la richiesta. Questo parametro può essere omesso dai container che non utilizzano le chiavi pubbliche per firmare le richieste o se il container organizza altri mezzi di distribuzione delle chiavi con la destinazione della richiesta.
                3. Firma la richiesta risultante in base alla sezione 9 della specifica OAuth.

              Gestione delle chiavi per gadget.io.PermissionType.SIGNED

              Se un container utilizza chiavi pubbliche per firmare le richieste, può scegliere di utilizzare i certificati autofirmati o i certificati firmati da un'autorità di certificazione nota. Se un container non distribuisce la propria chiave di firma OAuth su HTTPS, deve utilizzare un certificato firmato da un'autorità di certificazione nota.

              L'attributo commonName del certificato deve corrispondere al nome host del server container e corrispondere anche al valore del parametro oauth_consumer_key specificato nella richiesta.

              Il container dovrebbe rendere disponibile per il download la sua chiave pubblica in una posizione nota. La posizione https://container-hostname/opensocial/certificates/xoauth_signature_publickeyvalue è consigliata.

              I destinatari delle richieste firmate devono verificare che la firma della richiesta sia corretta e che il timestamp della richiesta sia entro un periodo di tempo ragionevole. Si consiglia una finestra temporale di 5 minuti prima e dopo l'ora corrente.

              I destinatari delle richieste firmate possono utilizzare i parametri oauth_consumer_key e xoauth_signature_publickey per rilevare automaticamente quando un container esegue il deployment di nuovi certificati. Se il container esegue il deployment dei certificati in una posizione nota, il destinatario può scaricare automaticamente il nuovo certificato. I destinatari che scaricano automaticamente nuovi certificati devono memorizzare nella cache i certificati risultanti.

              Se un certificato di un container non viene scaricato da https://container-hostname, il destinatario deve verificare che il certificato sia firmato da un'autorità di certificazione nota prima di considerare attendibile il certificato.

              Autorizzazione OAuth

              Se opt_params[gadgets.io.RequestParameters.AUTHORIZATION] è impostato su gadgets.io.AuthorizationType.OAUTH, il container deve utilizzare OAuth per ottenere l'accesso alla risorsa specificata nella richiesta. Ciò può richiedere che il gadget riceva i contenuti dell'utente indirizzando l'utente al fornitore di servizi per ottenere l'accesso.

              Parametri aggiuntivi

              I seguenti parametri aggiuntivi possono essere specificati in opt_params:

              gadget.io.RequestParameters.OAUTH_SERVICE_NAME
              Il nickname utilizzato dal gadget per fare riferimento all'elemento OAuth <Service> dalla relativa specifica XML. Se non viene specificato, il valore predefinito è "".
              gadget.io.RequestParameters.OAUTH_TOKEN_NAME
              Il nickname che il gadget utilizza per fare riferimento a un token OAuth che concede l'accesso a determinate risorse. Se non specificati, per impostazione predefinita """. I gadget possono utilizzare più nomi di token se hanno accesso a più risorse dello stesso fornitore di servizi. Ad esempio, un gadget con accesso a un elenco contatti e a un calendario potrebbe utilizzare il nome del token "contatti", per utilizzare il token dell'elenco contatti, e un elenco contatti di "calendario", per utilizzare il token del calendario.
              gadget.io.RequestParameters.OAUTH_REQUEST_TOKEN
              Un fornitore di servizi potrebbe essere in grado di eseguire il provisioning automatico di un gadget con un token di richiesta preapprovato per l'accesso a una risorsa. Il gadget può utilizzare il token con il parametro OAUTH_REQUEST_TOKEN. Questo parametro è facoltativo.
              gadget.io.RequestParameters.OAUTH_REQUEST_TOKEN_SECRET
              Il secret corrispondente a un token di richiesta preapprovato. Questo parametro è facoltativo.

              Se viene utilizzato OAuth, il container deve eseguire il protocollo OAuth per conto del gadget. Se il gadget non ha registrato una chiave consumer da utilizzare con questo fornitore di servizi, il container può scegliere di utilizzare una chiave di firma RSA predefinita corrispondente a un certificato noto per firmare le richieste. Se il container utilizza una chiave consumer predefinita, includerà un ulteriore parametro OAuth xoauth_app_url che identifica il gadget che esegue la richiesta.

              Il parametro di callback

              Il parametro di callback makeRequest() viene passato a un oggetto JavaScript con diversi campi specifici per OAuth oltre ai valori normali restituiti da makeRequest():

              "oauthApprovalUrl"
              Se questo valore è specificato, l'utente deve visitare una pagina esterna per approvare la richiesta d'accesso ai dati da parte del gadget. È consigliabile utilizzare una finestra popup per indirizzare l'utente alla pagina esterna. Una volta che l'utente ha approvato l'accesso, il gadget può ripetere la chiamata makeRequest per recuperare i dati.
              "oauthError"
              Se questo valore viene specificato, indica un errore relativo a OAuth. Il valore farà parte di un insieme di costanti stringa che possono essere utilizzate per il rilevamento programmatico degli errori. Le costanti non sono definite per opensocial-0.8, ma gli implementatori devono tentare di concordare un insieme di valori costanti utili per la standardizzazione in opensocial-0.9.
              "oauthErrorText"
              Se questo valore viene specificato, significa che si è verificato un errore relativo a OAuth. Il valore è un testo in formato libero che può essere utilizzato per fornire informazioni di debug agli sviluppatori di gadget.
                Parametri:
                  String url - L'URL in cui si trovano i contenuti
                  Function callback - La funzione da chiamare con i dati dall'URL una volta recuperati
              {15/10

              Torna all'inizio

              Static Class Gadget.io.PermissionType

              Utilizzato da RequestParameters.

              Riepilogo campo

              <static> object NONE
              Nessuna autorizzazione.
              <static> object OAUTH
              Il contenitore utilizzerà OAuth per l'autenticazione.
              <static> object SIGNED
              La richiesta verrà firmata dal container.
               

              Dettaglio campo

              NESSUNO

              <static> object NONE
                Nessuna autorizzazione.

              AUTENTICITÀ

              <static> object OAUTH
                Il contenitore utilizzerà OAuth per l'autenticazione.

              FIRMATO

              <static> object SIGNED
                La richiesta verrà firmata dal container.

              Torna all'inizio

              Static Class Gadget.io.ContentType

              Utilizzato da RequestParameters.

              Riepilogo campo

              <static> object DOM
              Restituisce un oggetto DOM; utilizzato per recuperare il codice XML.
              <static> object FEED
              Restituisce una rappresentazione JSON di un feed RSS o Atom.
              <static> object JSON
              Restituisce un oggetto JSON.
              <static> object TEXT
              Restituisce testo; utilizzato per recuperare l'HTML.
               

              Dettaglio campo

              DOM

              <static> object DOM
                Restituisce un oggetto DOM; utilizzato per recuperare XML.

              FEED

              <static> object FEED
                Restituisce una rappresentazione JSON di un feed RSS o Atom.

              JSON

              <static> object JSON
                Restituisce un oggetto JSON.

              TEXT

              <static> object TEXT
                Restituisce testo; utilizzato per recuperare l'HTML.

              Torna all'inizio

              Static Class Gadget.io.MethodType

              Definisce i valori per RequestParameters.METHOD.

              Riepilogo campo

              <static> object DELETE
              Il supporto del contenitore per questo tipo di metodo è FACOLTATIVO.
              <static> object GET
              Il tipo predefinito.
              <static> object HEAD
              Il supporto del contenitore per questo tipo di metodo è FACOLTATIVO.
              <static> object POST
              Il supporto del contenitore per questo tipo di metodo è FACOLTATIVO.
              <static> object PUT
              Il supporto del contenitore per questo tipo di metodo è FACOLTATIVO.
               

              Dettaglio campo

              ELIMINA

              <static> object DELETE
                Il supporto dei container per questo tipo di metodo è FACOLTATIVO.

              GET

              <static> object GET
                Il tipo predefinito.
              <static> object HEAD
                Il supporto dei container per questo tipo di metodo è FACOLTATIVO.

              POST

              <static> object POST
                Il supporto dei container per questo tipo di metodo è FACOLTATIVO.

              PUT

              <static> object PUT
                Il supporto dei container per questo tipo di metodo è FACOLTATIVO.

              Torna all'inizio

              Static Class Gadget.io.ProxyUrlRequestParameters

              Utilizzato dal metodo gadgets.io.getProxyUrl().

              Riepilogo campo

              <static> object REFRESH_INTERVAL
              Prova a utilizzare la memorizzazione nella cache dei contenuti.
               

              Dettaglio campo

              AGGIORNA INTERVALLO

              <static> object REFRESH_INTERVAL
                Prova a utilizzare la memorizzazione nella cache dei contenuti. L'intervallo di aggiornamento è il numero di secondi che vogliamo memorizzare nella cache. Per impostazione predefinita, vengono rispettate le intestazioni HTTP. Se non sono presenti intestazioni HTTP, questo valore predefinito sarà 3600 (un'ora). Tieni presente che le richieste e gli oggetti firmati con POST_DATA in genere non vengono memorizzati nella cache.

              Torna all'inizio

              Static Class Gadget.io.RequestParameters

              Utilizzato dal metodo gadgets.io.makeRequest().

              Riepilogo campo

              <static> object AUTHORIZATION
              Il tipo di autenticazione da utilizzare durante il recupero dei contenuti. Il valore predefinito è AuthorizationType.NONE.
              <static> object CONTENT_TYPE
              Il tipo di contenuti presenti nell'URL; il valore predefinito è ContentType.TEXT.
              <static> object GET_SUMMARIES
              Se i contenuti sono un feed, se recuperare i riepiloghi per quel feed; il valore predefinito è false.
              <static> object HEADERS
              Le intestazioni HTTP da inviare all'URL; il valore predefinito è null.
              <static> object METHOD
              Il metodo da usare per il recupero dei contenuti dall'URL. Il valore predefinito è MethodType.GET.
              <static> object NUM_ENTRIES
              Se i contenuti sono un feed, il numero di voci da recuperare è 3 per impostazione predefinita.
              <static> object POST_DATA
              I dati da inviare all'URL con il metodo POST; il valore predefinito è null.
               

              Dettaglio campo

              AUTORIZZAZIONE

              <static> object AUTHORIZATION
                Il tipo di autenticazione da utilizzare durante il recupero dei contenuti. Il valore predefinito è AuthorizationType.NONE. Specificato come PermissionType.

              CONTENT_TYPE

              <static> object CONTENT_TYPE
                Il tipo di contenuti presenti nell'URL; il valore predefinito è ContentType.TEXT. Specificato come ContentType.

              GET_SUMMARIES

              <static> object GET_SUMMARIES
                Se i contenuti sono un feed, se recuperare i riepiloghi per quel feed; il valore predefinito è false. Specificato come Boolean.

              INTESTAZIONI

              <static> object HEADERS
                Le intestazioni HTTP da inviare all'URL; il valore predefinito è null. Specificato come Map.<String,String>.

              Metodo

              <static> object METHOD
                Metodo da utilizzare per il recupero di contenuti dall'URL. Il valore predefinito è MethodType.GET. I valori validi sono specificati da MethodType.

              NUM_ENTRIES

              <static> object NUM_ENTRIES
                Se i contenuti sono un feed, il numero di voci da recuperare è 3 per impostazione predefinita. Specificato come Number.

              POST_DATI

              <static> object POST_DATA
                I dati da inviare all'URL con il metodo POST; il valore predefinito è null. Specificato come String.

              Torna all'inizio

              Static Class Gadget.json

              Fornisce operazioni per la traduzione di oggetti da e verso JSON.

              Riepilogo metodo

              <static>  Object parse(text)
              Analizza una stringa JSON generando un valore JavaScript.
              <static>  String stringify(v)
              Converte un valore JavaScript in una stringa JSON.
               

              Dettaglio metodo

              parse

              <static> Object parse(text)
                Analizza una stringa JSON che produce un valore JavaScript.
                Parametri:
                  String text - La stringa da trasformare in oggetto, solitamente il risultato di una chiamata di stringa precedente
                Restituisce:
                  Object  L'oggetto analizzato dal testo passato; false se si è verificato un errore

              stringa

              <static> String stringify(v)
                Converte un valore JavaScript in una stringa JSON.
                Parametri:
                  Object v - L'oggetto da convertire
                Restituisce:
                  String  L'equivalente JSON

              Torna all'inizio

              Static Class Gadget.pubsub

              Fornisce operazioni per la pubblicazione e l'iscrizione ai canali dei messaggi.

              Riepilogo metodo

              <static> publish(channelName, message)
              Pubblica un messaggio di tipo stringa su un canale.
              <static> subscribe(channelName, callback)
              Iscrive un gadget a un canale di messaggistica.
              <static> unsubscribe(channelName)
              Annulla l'iscrizione del gadget a un canale contenente un messaggio.
               

              Dettaglio metodo

              publish

              <static> publish(channelName, message)
                Pubblica un messaggio di tipo stringa su un canale.
                Parametri:
                  String channelName - Il nome del canale
                  String message - Il messaggio da pubblicare

              iscriversi

              <static> subscribe(channelName, callback)
                Iscrive un gadget a un canale messaggio.
                Parametri:
                  String channelName - Il nome del canale
                  Function callback - Una funzione che verrà chiamata con i messaggi del canale

              annullare l'iscrizione

              <static> unsubscribe(channelName)
                Annulla l'iscrizione del gadget a un canale di messaggistica.
                Parametri:
                  String channelName - Il nome del canale

              Torna all'inizio

              Static Class Gadget.rpc

              Fornisce operazioni per effettuare chiamate di procedura remota per la comunicazione da gadget a container, da container a gadget e da gadget a gadget.

              Riepilogo metodo

              <static> call(targetId, serviceName, callback, var_args)
              Chiama un servizio RPC.
              <static> register(serviceName, handler)
              Registra un servizio RPC.
              <static> registerDefault(handler)
              Registra un gestore di servizi predefinito per elaborare tutte le chiamate di operazioni da remoto sconosciute, che per impostazione predefinita non vengono eseguite correttamente.
              <static> unregister(serviceName)
              Annulla la registrazione di un servizio RPC.
              <static> unregisterDefault()
              Annulla la registrazione del gestore di servizi predefinito.
               

              Dettaglio metodo

              Chiama

              <static> call(targetId, serviceName, callback, var_args)
                Chiama un servizio RPC.
                Parametri:
                  String targetId - ID del provider di servizi RPC; vuoto se chiami il container padre
                  String serviceName - Nome del servizio da chiamare
                  Function, null callback - Funzione di callback (se presente) per elaborare il valore restituito della richiesta RPC
                  * var_args - Parametri per la richiesta RPC

              register

              <static> register(serviceName, handler)
                Registra un servizio RPC.
                Parametri:
                  String serviceName - Nome del servizio da registrare
                  Function handler - Gestore di servizi

              registraDefault

              <static> registerDefault(handler)
                Registra un gestore di servizi predefinito per elaborare tutte le chiamate di procedura remota sconosciute, che per impostazione predefinita non vengono eseguite correttamente.
                Parametri:
                  Function handler - Gestore di servizi

              unregister

              <static> unregister(serviceName)
                Annulla la registrazione di un servizio RPC.
                Parametri:
                  String serviceName - Nome del servizio di cui annullare la registrazione

              annulla registrazione

              <static> unregisterDefault()
                Annulla la registrazione del gestore di servizi predefinito. In futuro, le chiamate di procedura remota sconosciute non riusciranno.

              Torna all'inizio

              Static Class Gadgets.skin

              Fornisce operazioni per ottenere informazioni di visualizzazione sulla pelle attualmente mostrata.

              Riepilogo metodo

              <static>  String getProperty(propertyKey)
              Recupera la proprietà display mappata alla chiave specificata.
               

              Dettaglio metodo

              getProperty

              <static> String getProperty(propertyKey)
                Recupera la proprietà display mappata alla chiave specificata.
                Parametri:
                Restituisce:
                  String  I dati
              {14

              Torna all'inizio

              Static Class Gadgets.skins.Property

              Tutti i valori display che possono essere recuperati e utilizzati nell'interfaccia utente dei gadget. Queste sono le chiavi supportate per il metodo Gadgets.skins.getProperty().

              Riepilogo campo

              <static> object ANCHOR_COLOR
              Il colore che dovrebbe usare i tag di ancoraggio.
              <static> object BG_COLOR
              Il colore dello sfondo del gadget.
              <static> object BG_IMAGE
              Un'immagine da utilizzare come sfondo del gadget.
              <static> object FONT_COLOR
              Il colore in cui deve essere visualizzato il carattere principale.
               

              Dettaglio campo

              ANCHOR_COLORE

              <static> object ANCHOR_COLOR
                Il colore che devono essere utilizzati dai tag di ancoraggio.

              Colore_BG

              <static> object BG_COLOR
                Il colore dello sfondo del gadget.

              Immagine_BG

              <static> object BG_IMAGE
                Un'immagine da utilizzare come sfondo del gadget.

              Carattere_COLORE

              <static> object FONT_COLOR
                Il colore in cui deve essere visualizzato il carattere principale.

              Torna all'inizio

              Static Class Gadget.util

              Fornisce funzioni di utilità per uso generico.

              Riepilogo metodo

              <static>  String escapeString(str)
              Esegui l'escape dell'input utilizzando entità HTML per renderlo più sicuro.
              <static>  Object getFeatureParameters(feature)
              Restituisce il valore dei parametri per questa funzionalità.
              <static>  Boolean hasFeature(feature)
              Restituisce se la funzionalità specificata è supportata.
              <static> registerOnLoadHandler(callback)
              Registra un gestore onload, una funzione che viene eseguita al caricamento del gadget.
              <static>  String unescapeString(str)
              Inverte escapeString

              Dettaglio metodo

              escapeString

              <static> String escapeString(str)
                Esegue l'escape dell'input utilizzando entità HTML per renderlo più sicuro. Sono interessati i seguenti caratteri:
                • nuova riga (\n, punto codice Unicode 10)
                • ritorno a capo (\r, Unicode 13)
                • virgolette doppie (", Unicode 34)
                • e commerciale (&, Unicode 38)
                • citazione singola (', Unicode 39)
                • Parentesi quadra aperta (<, Unicode 60)
                • Parentesi angolare chiusa (>, Unicode 62)
                • barra rovesciata (\, Unicode 92)
                • separatore di riga (Unicode 8232)
                • separatore di paragrafo (Unicode 8233)
                Parametri:
                  String str - La stringa di escape
                Restituisce:
                  String  La stringa con caratteri di escape

              Parametri GetFeature

              <static> Object getFeatureParameters(feature)
                Restituisce il valore dei parametri per questa funzionalità. Un gadget specifica i parametri utilizzando l'elemento secondario <Param> dell'elemento <Requires> o <Optional>.
                Parametri:
                  String feature - La funzionalità per ottenere i parametri per
                Restituisce:
                  Object  I parametri per la funzionalità specificata, oppure null

              conFunzionalità

              <static> Boolean hasFeature(feature)
                Restituisce se la funzionalità specificata è supportata.
                Parametri:
                  String feature - La funzionalità di cui eseguire il test
                Restituisce:
                  Boolean  True se la funzionalità è supportata

              registerOnLoadHandler

              <static> registerOnLoadHandler(callback)
                Registra un gestore onload, una funzione che viene eseguita al caricamento del gadget.
                Parametri:
                  Function callback - Il gestore da eseguire

              unescapeString

              <static> String unescapeString(str)
                Inverte escapeString
                Parametri:
                  String str - La stringa da rimuovere tramite escape.
                Restituisce:
                  String  La stringa senza caratteri di escape

              Torna all'inizio

              Static Class Gadgets.Views

              Fornisce operazioni per la gestione delle visualizzazioni.

              Vedi anche: gadgets.views.View

              Riepilogo metodo

              <static>  String bind(urlTemplate, environment)
              Associa un modello di URL con le variabili nell'ambiente passato per produrre una stringa di URL.
              <static>  gadgets.views.View getCurrentView()
              Restituisce la visualizzazione corrente.
              <static>  Map.<String, String> getParams()
              Restituisce i parametri passati in questo gadget per questa vista.
              <static>  Map<gadgets.views.ViewType, String, gadgets.views.View> getSupportedViews()
              Restituisce una mappa di tutte le visualizzazioni supportate.
              <static> requestNavigateTo(view, opt_params, opt_ownerId)
              Tenta di accedere a questo gadget in una visualizzazione diversa.
               

              Dettaglio metodo

              bind

              <static> String bind(urlTemplate, environment)
                Associa un modello di URL con variabili nell'ambiente passato per produrre una stringa di URL.

                Vedi anche: View.getUrlTemplate()

                Parametri:
                  urlTemplate - Un modello di URL per una visualizzazione container
                  environment - Un insieme di variabili denominate (ad esempio [OWNER | PATH | PARAMS | NAME]) di stringa di tipo.
                Restituisce:
                  String  Una stringa di URL

              getCurrentView

              <static> gadgets.views.View getCurrentView()
                Restituisce la vista corrente.
                Restituisce:
                  gadgets.views.View  La visualizzazione corrente

              getParams

              <static> Map.<String, String> getParams()
                Restituisce i parametri passati in questo gadget per questa vista. Non include tutti i parametri URL, solo quelli passati in gadgets.views.requestNavigazioneTo.
                Restituisce:
                  Map.<String, String>  La mappa dei parametri

              getSupportedViews

              <static> Map<gadgets.views.ViewType, String, gadgets.views.View> getSupportedViews()
                Restituisce una mappa di tutte le viste supportate. Chiavi Ogni gadget.view.View per il nome.
                Restituisce:
                  Map<gadgets.views.ViewType, String, gadgets.views.View>  Tutte le visualizzazioni supportate, inserite dall'attributo name.

              richiestaVai a

              <static> requestNavigateTo(view, opt_params, opt_ownerId)
                Tenta di passare a questo gadget in una visualizzazione diversa. Se il parametro supporta i container, passeranno i parametri facoltativi al gadget nella nuova visualizzazione.
                Parametri:
                  gadgets.views.View view - La visualizzazione per raggiungere
                  Map.<String, String> opt_params - Parametri da passare al gadget dopo che è stato visualizzato sulla piattaforma
                  String opt_ownerId - L'ID del proprietario della pagina per la navigazione; il valore predefinito è quello dell'attuale proprietario
              /4

              Torna all'inizio

              Gadget.views.View di classe

              Interfaccia di base per tutti gli oggetti di visualizzazione.

              Riepilogo metodo

               String bind(environment)
              Associa il modello di URL della vista con variabili nell'ambiente passato per produrre una stringa di URL.
               gadgets.views.ViewType, String getName()
              Restituisce il nome di questa visualizzazione.
               String getUrlTemplate()
              Restituisce un modello di stringa stringa conforme alla bozza specifica IEIE con variabili per la sostituzione.
               boolean isOnlyVisibleGadget()
              Restituisce true se il gadget è l'unico gadget visibile in questa visualizzazione.
               

              Dettaglio metodo

              bind

              String bind(environment)
                Associa il modello di URL della vista con variabili nell'ambiente passato per produrre una stringa URL.

                Vedi anche: getUrlTemplate()

                Parametri:
                  environment - Un insieme di variabili denominate (ad esempio [OWNER | PATH | PARAMS | NAME]) di stringa di tipo.
                Restituisce:
                  String  Una stringa di URL

              getName

              gadgets.views.ViewType, String getName()
                Restituisce il nome di questa vista.
                Restituisce:
                  gadgets.views.ViewType, String  Il nome della visualizzazione, generalmente specificato come gadgets.views.ViewType

              Modello URL

              String getUrlTemplate()
                Restituisce un modello di stringa stringa conforme alla bozza specifica IETF con variabili per la sostituzione.

                Sono supportate quattro variabili:

                name
                Il nome o l'ID dell'applicazione
                proprietario
                L'ID del proprietario della pagina
                percorso
                Un array di passaggi del percorso
                parametri
                Array o array associato[param1,value1,param2,value2,...]

                Esempio

                Ecco due stringhe di modello di URL valide:

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

                Ecco alcuni parametri:

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

                Con questi parametri, le due stringhe di modello di URL di esempio vengono risolti nei seguenti URL:

                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
                

                Vedi anche: bind()

                Restituisce:
                  String  Un modello che può essere utilizzato per creare URL che rimandano a questa vista

              IsOnlyVisible Gadget

              boolean isOnlyVisibleGadget()
                Restituisce true se il gadget è l'unico visibile in questa visualizzazione. In una pagina canvas o in modalità di massimizzazione, molto probabilmente è vero; in una pagina del profilo o in modalità dashboard, molto probabilmente è falso.
                Restituisce:
                  boolean  True se il gadget è l'unico visibile, altrimenti è false

              Torna all'inizio

              Static Class Gadget.views.ViewType

              Utilizzate dalle visualizzazioni.

              Riepilogo campo

              <static> object CANVAS
              Una visualizzazione in cui il gadget viene visualizzato in una modalità molto grande.
              <static> object HOME
              Una visualizzazione in cui il gadget viene visualizzato in una piccola area di solito su una pagina con altri gadget.
              <static> object PREVIEW
              Una visualizzazione demo del gadget.
              <static> object PROFILE
              Una visualizzazione in cui il gadget viene visualizzato in una piccola area di solito su una pagina con altri gadget.
               

              Dettaglio campo

              TESSUTO

              <static> object CANVAS
                Una visualizzazione in cui il gadget viene visualizzato in modalità molto grande. In genere sono i contenuti principali della pagina. Il visualizzatore non è sempre uguale al proprietario.

              HOME

              <static> object HOME
                Una visualizzazione in cui il gadget viene visualizzato in una piccola area di solito in una pagina con altri gadget. In genere lo spettatore è il proprietario.

              ANTEPRIMA

              <static> object PREVIEW
                Una visualizzazione demo del gadget. In questa visualizzazione, il proprietario e lo spettatore non sono noti.

              PROFILO

              <static> object PROFILE
                Una visualizzazione in cui il gadget viene visualizzato in una piccola area di solito in una pagina con altri gadget. Lo spettatore non corrisponde sempre al proprietario.

              Torna all'inizio

              Static Class Gadget.window

              Fornisce operazioni per ottenere informazioni sulla finestra in cui si trova il gadget e per modificarla.

              Riepilogo metodo

              <static> adjustHeight(opt_height)
              Regola l'altezza del gadget.
              <static>  Object getViewportDimensions()
              Rileva le dimensioni interne di un frame.
              <static> setTitle(title)
              Imposta il titolo del gadget.
               

              Dettaglio metodo

              regolareAltezza

              <static> adjustHeight(opt_height)
                Regola l'altezza del gadget.
                Parametri:
                  Number opt_height - Un'altezza facoltativa facoltativa in pixel; se non specificata, verrà tentata l'adattamento del gadget ai relativi contenuti

              getViewportSize

              <static> Object getViewportDimensions()
                Restituisce:
                  Object  Un oggetto con proprietà di larghezza e altezza

              setTitle

              <static> setTitle(title)
                Imposta il titolo del gadget.
                Parametri:
                  String title - Il titolo preferito

              Torna all'inizio