Cette page a été traduite par l'API Cloud Translation.

Class ListItem

Obsolète. Cette classe est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Un élément de liste de sites : un élément de liste issu d'une page de liste de sites.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`deleteListItem()`	`void`	Supprime cet élément de liste.
`getDatePublished()`	`Date`	Renvoie la date à laquelle cet élément de liste a été publié pour la première fois.
`getLastUpdated()`	`Date`	Affichez la date de la dernière mise à jour de ce commentaire.
`getParent()`	`Page`	Permet d'obtenir la page parente de cet élément de liste.
`getValueByIndex(index)`	`String`	Récupère la valeur de cet élément ListItem pour une colonne numérotée.
`getValueByName(name)`	`String`	Récupère la valeur de cet élément ListItem pour une colonne nommée.
`setParent(parent)`	`ListItem`	Définissez la page parente de cet élément de liste.
`setValueByIndex(index, value)`	`ListItem`	Définissez la valeur de cet élément ListItem pour une colonne numérotée.
`setValueByName(name, value)`	`ListItem`	Définissez la valeur de cet élément ListItem pour une colonne numérotée.

Méthodes obsolètes

`deleteListItem()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Supprime cet élément de liste.

// This code sample deletes all list items from a List page
// Running this code sample against a Page that is a standard web page will
// cause getListItems() to throw an exception
var page = SitesApp.getSite('demositeappsscript').getChildByName('mylistpage');
var items = page.getListItems();
for(var i = 0; i < items.length; i++) {
  items[i].deleteListItem();
}

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getDatePublished()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Renvoie la date à laquelle cet élément de liste a été publié pour la première fois.

var page = SitesApp.getSite('example.com', 'mysite').getChildByName('mylistpage');
var items = page.getListItems();
var date = items[0].getDatePublished();

Renvois

Date : date de publication d'origine

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getLastUpdated()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Affichez la date de la dernière mise à jour de ce commentaire.

var page = SitesApp.getSite('example.com', 'mysite').getChildByName('mylistpage');
var items = page.getListItems();
var date = items[0].getLastUpdated();

Renvois

Date : date de la dernière mise à jour

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getParent()`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Permet d'obtenir la page parente de cet élément de liste.

var page = SitesApp.getSite('example.com', 'mysite').getChildByName('mylistpage');
var items = page.getListItems();
// parentPage will equal page
var parentPage = items[0].getParent();

Renvois

Page : page parente

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getValueByIndex(index)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Récupère la valeur de cet élément ListItem pour une colonne numérotée.

var page = SitesApp.getSite("demositeappsscript").getChildByName("mylistpage");
var listItem = page.getListItems()[0];

// Remember that rows are 0 indexed. This returns the item in the first column
// of the list. If an index that is greater than the number of columns is used,
// the script will throw an "InvalidArgument: index" exception.
var value = listItem.getValueByIndex(5);

Paramètres

Nom	Type	Description
`index`	`Integer`	la colonne pour obtenir la valeur de

Renvois

String : valeur de cette colonne

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`getValueByName(name)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Récupère la valeur de cet élément ListItem pour une colonne nommée.

var page = SitesApp.getSite("demositeappsscript").getChildByName("mylistpage");
var listItem = page.getListItems()[0];

// Suppose we have a column named "Owner" - this will let us fetch the value
// for the list item
var value = listItem.getValueByName("Owner");
Logger.log(value);

Paramètres

Nom	Type	Description
`name`	`String`	la colonne pour obtenir la valeur de

Renvois

String : valeur de cette colonne

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`setParent(parent)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Définissez la page parente de cet élément de liste.

var page = SitesApp.getSite('example.com', 'mysite').getChildByName('mylistpage');
var secondListPage = SitesApp.getSite('example.com', 'mysite')
                             .getChildByName('secondlistpage');
var items = page.getListItems();

// Returns secondListPage
var parentPage = items[0].setParent(secondListPage).getParent();

Paramètres

Nom	Type	Description
`parent`	`Page`	le nouveau parent

Renvois

ListItem : cet élément ListItem pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`setValueByIndex(index, value)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Définissez la valeur de cet élément ListItem pour une colonne numérotée. Pour les colonnes d'URL, la valeur doit être une balise d'ancrage XHTML, avec des entités XML échappées.

var page = SitesApp.getSite("example.com", "mysite").getChildByName("mylistpage");
var listItem = page.getListItems()[0];
listItem.setValueByIndex(1, 'This is the new value');
listItem.setValueByIndex(2, '<a href="http://www.example.com?a=1&amp;b=2">Example</a>');

Paramètres

Nom	Type	Description
`index`	`Integer`	la colonne pour définir la valeur de
`value`	`String`	la nouvelle valeur

Renvois

ListItem : cet élément ListItem pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds

`setValueByName(name, value)`

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Définissez la valeur de cet élément ListItem pour une colonne numérotée. Pour les colonnes d'URL, la valeur doit être une balise d'ancrage XHTML, avec des entités XML échappées.

var page = SitesApp.getSite("demositeappsscript").getChildByName("mylistpage");
var listItem = page.getListItems()[0];
listItem.setValueByName('Owner', 'Eric');
listItem.setValueByName('Page', '<a href="http://www.example.com?a=1&amp;b=2">Example</a>');

Paramètres

Nom	Type	Description
`name`	`String`	la colonne pour définir la valeur de
`value`	`String`	la nouvelle valeur

Renvois

ListItem : cet élément ListItem pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

https://sites.google.com/feeds