API REST du plan de données Azure SignalR Service - v1-preview

  • Article

Cet article contient les API REST version v1-preview obsolètes pour le plan de données Azure SignalR Service. Utilisez plutôt la dernière version.

API disponibles

API Chemin d’accès
post /api/v1-preview/hub/{hub}/user/{id} POST /api/v1-preview/hub/{hub}/user/{id}
post /api/v1-preview/hub/{hub}/users/{userList} POST /api/v1-preview/hub/{hub}/users/{userList}
post /api/v1-preview/hub/{hub} POST /api/v1-preview/hub/{hub}
post /api/v1-preview/hub/{hub}/group/{group} POST /api/v1-preview/hub/{hub}/group/{group}
post /api/v1-preview/hub/{hub}/groups/{groupList} POST /api/v1-preview/hub/{hub}/groups/{groupList}

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

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

Description :

Envoyer un message à un seul utilisateur.

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
id path ID utilisateur cible. Oui string
message corps Oui Message
Réponses
Code Description
202 Accepted

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

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

Description :

Envoyer un message à plusieurs utilisateurs.

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
userList path Liste des ID utilisateur séparés par des virgules. Oui string
message corps Oui Message
Réponses
Code Description
202 Accepted

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

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

Description :

Diffuser un message à tous les clients connectés au hub cible.

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
message corps Oui Message
Réponses
Code Description
202 Accepted

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

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

Description :

Diffuser un message à tous les clients au sein du groupe cible.

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
groupe path Nom du groupe cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
message corps Oui Message
Réponses
Code Description
202 Accepted

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

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

Description :

Diffuser un message à tous les clients au sein des groupes cibles.

Paramètres
Nom Emplacement Description Obligatoire schéma
hub path Nom du hub cible qui doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
groupList path Liste des noms de groupe séparés par des virgules. Chaque nom de groupe doit commencer par des caractères alphabétiques et ne contenir que des caractères alphanumériques ou traits de soulignement. Oui string
message corps Oui Message
Réponses
Code Description
202 Accepted

Modèles

Message

Message d’appel de méthode.

Nom Type Description Obligatoire
cible string Nom de la méthode cible. Non
arguments [ object ] Arguments de méthode cible. Non