Pages

Afficher les obsolètes

*Ce contenu est traduit en utilisant l'IA (Beta) et peut contenir des erreurs. Pour consulter cette page en anglais, clique ici.

Création impossible
Non répliqué

Un objet qui est essentiellement une table de pages, chacune desquelles est une liste triée des paires clé/valeur.

Échantillons de code

When each page in a Pages object contains a list of multiple items, this iterator function and its helper may be useful.

Pages Iterator

-- Reformat pages as tables
local function pagesToTable(pages)
local items = {}
while true do
table.insert(items, pages:GetCurrentPage())
if pages.IsFinished then
break
end
pages:AdvanceToNextPageAsync()
end
return items
end
local function iterPageItems(pages)
local contents = pagesToTable(pages)
-- Track the current page number starting at 1
local pageNum = 1
-- Get last page number so we don't iterate over it
local lastPageNum = #contents
-- for resumes this coroutine until there's nothing to go through
return coroutine.wrap(function()
-- Loop until page number is greater than last page number
while pageNum <= lastPageNum do
-- Go through all the entries of the current page
for _, item in ipairs(contents[pageNum]) do
-- Pause loop to let developer handle entry and page number
coroutine.yield(item, pageNum)
end
pageNum += 1
end
end)
end
-- Using the iterPageItems function to iterate through the pages of a catalog search
local AvatarEditorService = game:GetService("AvatarEditorService")
local parameters = CatalogSearchParams.new()
parameters.SearchKeyword = "Hair"
local catalogPages = AvatarEditorService:SearchCatalog(parameters)
for item, pageNumber in iterPageItems(catalogPages) do
print(item, pageNumber)
end

Résumé

Propriétés

  • Lecture uniquement
    Non répliqué
    Lecture parallèle

    Si la page actuelle est la dernière page disponible ou non.

Méthodes

  • Renvoie les éléments de la page actuelle. Les clés de l'élément sont déterminées par la source de cet objet.

  • Itère vers la page suivante dans l'objet pages, si possible.

Propriétés

IsFinished

Lecture uniquement
Non répliqué
Lecture parallèle

Si la page actuelle est la dernière page disponible ou non.

Méthodes

GetCurrentPage

Renvoie les éléments de la page actuelle. Les clés de l'élément sont déterminées par la source de cet objet.


Retours

AdvanceToNextPageAsync

()
Rendement

Itère vers la page suivante dans l'objet pages, si possible. La limite de requête est la même que l'endpoint initialement appelé.


Retours

()

Évènements