Pular para o conteúdo principal

getAllSubscriptions

Este método retorna todas as assinaturas de produtos. 🔐 Este método requer autorização.

Descrição​

Ele retorna uma Promise que resolve para um objeto ISubscriptions.

.getAllSubscriptions(

,

);

Esquema de parâmetros​

Esquema

offset: number
Parâmetro de paginação, o padrão é 0
exemplo: 0

limit: number
Parâmetro de paginação, o padrão é 30
exemplo: 30

Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registros nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar Permissões do módulo (abre em uma nova aba) de acordo com suas necessidades na seção correspondente.*

Exemplos​

Exemplo mínimo​

const response = await Events.getAllSubscriptions();

Exemplo com atributos​

const response = await Events.getAllSubscriptions(0, 30);

Exemplo de resposta​

{
  "total": 100,
  "items": [
    {
      "eventMarker": "string",
      "productId": 0
    }
  ]
}

Esquema de resposta​

Esquema: ISubscriptions

total: number
Total de registros encontrados

items: ISubscriptionItem[]
Marcador de evento

items.eventMarker: string
Marcador de evento

items.productId number
Identificador do produto