API REST do plano de dados do Serviço Azure SignalR - v1-preview

  • Artigo

Este artigo contém as APIs REST obsoletas da versão v1-preview para o plano de dados do Serviço Azure SignalR. Em vez disso, utilize a versão mais recente.

APIs disponíveis

API Caminho
postar /api/v1-preview/hub/{hub}/user/{id} POST /api/v1-preview/hub/{hub}/user/{id}
postar /api/v1-preview/hub/{hub}/users/{userList} POST /api/v1-preview/hub/{hub}/users/{userList}
postar /api/v1-preview/hub/{hub} POST /api/v1-preview/hub/{hub}
postar /api/v1-preview/hub/{hub}/group/{group} POST /api/v1-preview/hub/{hub}/group/{group}
postar /api/v1-preview/hub/{hub}/groups/{groupList} POST /api/v1-preview/hub/{hub}/groups/{groupList}

postar /api/v1-preview/hub/{hub}/user/{id}

POST /api/v1-preview/hub/{hub}/user/{id}

Descrição:

Envie uma mensagem para um único usuário.

Parâmetros
Nome Localizada em Descrição Necessária Esquema
hub path Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado. Sim string
ID path ID do usuário alvo. Sim string
mensagem corpo Sim Mensagem
Respostas
Código Descrição
202 Aceite

postar /api/v1-preview/hub/{hub}/users/{userList}

POST /api/v1-preview/hub/{hub}/users/{userList}

Descrição:

Envie uma mensagem para vários usuários.

Parâmetros
Nome Localizada em Descrição Necessária Esquema
hub path Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado. Sim string
Lista de utilizadores path Lista separada por vírgulas de IDs de usuário. Sim string
mensagem corpo Sim Mensagem
Respostas
Código Descrição
202 Aceite

postar /api/v1-preview/hub/{hub}

POST /api/v1-preview/hub/{hub}

Descrição:

Difunda uma mensagem para todos os clientes conectados ao hub de destino.

Parâmetros
Nome Localizada em Descrição Necessária Esquema
hub path Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado. Sim string
mensagem corpo Sim Mensagem
Respostas
Código Descrição
202 Aceite

postar /api/v1-preview/hub/{hub}/group/{group}

POST /api/v1-preview/hub/{hub}/group/{group}

Descrição:

Difundir uma mensagem para todos os clientes dentro do grupo-alvo.

Parâmetros
Nome Localizada em Descrição Necessária Esquema
hub path Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado. Sim string
grupo path Nome do grupo-alvo, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado. Sim string
mensagem corpo Sim Mensagem
Respostas
Código Descrição
202 Aceite

postar /api/v1-preview/hub/{hub}/groups/{groupList}

POST /api/v1-preview/hub/{hub}/groups/{groupList}

Descrição:

Difundir uma mensagem para todos os clientes dentro dos grupos-alvo.

Parâmetros
Nome Localizada em Descrição Necessária Esquema
hub path Nome do hub de destino, que deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado. Sim string
lista de grupos path Lista separada por vírgulas de nomes de grupos. Cada nome de grupo deve começar com caracteres alfabéticos e conter apenas caracteres alfanuméricos ou sublinhado. Sim string
mensagem corpo Sim Mensagem
Respostas
Código Descrição
202 Aceite

Modelos

Mensagem

Mensagem de invocação do método.

Nome Tipo Descrição Necessária
destino string Nome do método de destino. Não
Argumentos [ objeto ] Argumentos do método de destino. Não