Pages

Mostrar obsoleto

*Este conteúdo é traduzido por IA (Beta) e pode conter erros. Para ver a página em inglês, clique aqui.

Não criável
Não replicado

Um objeto que é basicamente uma tabela de páginas, cada uma das quais é uma lista ordenada dos pares de chave/valor.

Amostras de código

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

Resumo

Propriedades

  • Somente leitura
    Não replicado
    Ler Parallel

    Independentemente de a página atual ser a última página disponível.

Métodos

  • Retorna os itens na página atual. As chaves do item são determinadas pela fonte deste Objeto.

  • Rendimentos

    itera para a próxima página no Objetode páginas, se possível.

Propriedades

IsFinished

Somente leitura
Não replicado
Ler Parallel

Independentemente de a página atual ser a última página disponível.

Métodos

GetCurrentPage

Retorna os itens na página atual. As chaves do item são determinadas pela fonte deste Objeto.


Devolução

AdvanceToNextPageAsync

void
Rendimentos

itera para a próxima página no Objetode páginas, se possível. O limite de solicitação é o mesmo do endpoint original.


Devolução

void

Eventos