Esquecer

SubscriçãoSem Autenticação

Pare um stream em tempo real pelo seu ID. Sem alterações na nova API.

Sem alterações de rutura

A chamada forget funciona da mesma forma na API Legada e na Nova API, pelo que não precisa de alterar o seu código.

Comparação rápida

Aspeto	Legacy API	New API	Ação
Endpoint	forget	forget	Nenhum
Autenticação Obrigatória	Não	Não	Nenhum
Padrão de ID de stream	`^[\w-]{32,128}$`	`^[\w-]{32,128}$`	Nenhum
Campo de resposta `forget`	Opcional	Opcional	Nenhum

Campos de pedido e resposta

Pedido

forget (obrigatório): o ID do stream, correspondente a ^[\w-]{32,128}$. Utilize o subscription.id do stream que pretende parar.
passthrough (opcional): dados devolvidos a si em echo_req.
req_id (opcional): um ID que associa a resposta ao seu pedido.

Resposta

echo_req e msg_type (forget): sempre devolvidos.
forget (opcional): 1 significa que o fluxo foi interrompido. 0 significa que o fluxo não existia.
req_id: devolvido quando envia um.

Estrutura de pedido

Legacy APIexemplo de pedido

{
  "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
}

New APIexemplo de pedido

{
  "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
}

Estrutura de resposta

Legacy APIexemplo de resposta

{
  "echo_req": {
    "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
  },
  "forget": 1,
  "msg_type": "forget"
}

New APIexemplo de resposta

{
  "echo_req": {
    "forget": "d1ee7d0d-3ca9-fbb4-720b-5312d487185b"
  },
  "forget": 1,
  "msg_type": "forget"
}

Exemplos de código

function stopStream(streamId) {
  ws.send(JSON.stringify({ forget: streamId }));
}

ws.onmessage = (event) => {
  const response = JSON.parse(event.data);
  if (response.error) {
    console.error(response.error.message);
    return;
  }
  if (response.msg_type !== 'forget') return;

  if (response.forget === 1) {
    console.log('Stream stopped');
  } else if (response.forget === 0) {
    console.log('Stream did not exist');
  } else {
    console.log('No forget result returned');
  }
};

Endpoints de Subscrições Esquecer tudo

Alguma outra questão? Entrar em contacto