WebPubSubServiceClient class

Pakket:

@azure/web-pubsub

Client voor het maken van verbinding met een Web PubSub-hub

Constructors

WebPubSubServiceClient(string, AzureKeyCredential | TokenCredential, string, WebPubSubServiceClientOptions)	Hiermee maakt u een exemplaar van een WebPubSubServiceClient voor het verzenden van berichten en het beheren van groepen, verbindingen en gebruikers. Voorbeeldgebruik: import { AzureKeyCredential, WebPubSubServiceClient } from "@azure/web-pubsub"; const key = new AzureKeyCredential("<Key>"); const serviceClient = new WebPubSubServiceClient("<Endpoint>", key, "<hubName>");
WebPubSubServiceClient(string, string, WebPubSubServiceClientOptions)	Hiermee maakt u een exemplaar van een WebPubSubServiceClient voor het verzenden van berichten en het beheren van groepen, verbindingen en gebruikers. Voorbeeldgebruik: import { WebPubSubServiceClient } from "@azure/web-pubsub"; const serviceClient = new WebPubSubServiceClient("<ConnectionString>", "<hubName>");

Eigenschappen

apiVersion	De Web PubSub-API-versie die door deze client wordt gebruikt
endpoint	Het Web PubSub-eindpunt waarop deze client is verbonden
hubName	De naam van de hub waarop deze client is verbonden

Methoden

addConnectionsToGroups(string[], string, GroupAddConnectionOptions)	Gefilterde verbindingen toevoegen aan meerdere groepen
closeAllConnections(HubCloseAllConnectionsOptions)	Alle verbindingen met deze hub sluiten
closeConnection(string, HubCloseConnectionOptions)	Een specifieke verbinding met deze hub sluiten
closeUserConnections(string, HubCloseUserConnectionsOptions)	Alle verbindingen met de opgegeven gebruikers-id sluiten
connectionExists(string, HasConnectionOptions)	Controleer of een specifieke verbinding is verbonden met deze hub
getClientAccessToken(GenerateClientTokenOptions)	Genereer een token voor een client om verbinding te maken met de Azure Web PubSub-service.
grantPermission(string, Permission, HubGrantPermissionOptions)	Machtigingen verlenen aan een verbinding
group(string)	Een client voor een groep ophalen
groupExists(string, HubHasGroupOptions)	Controleer of er een bepaalde groep bestaat (bijvoorbeeld actieve verbindingen).
hasPermission(string, Permission, HubHasPermissionOptions)	Controleer of de verbinding de opgegeven machtiging heeft
removeConnectionFromAllGroups(string, HubCloseConnectionOptions)	Een specifieke verbinding verwijderen uit alle groepen waaraan ze lid zijn
removeConnectionsFromGroups(string[], string, GroupRemoveConnectionOptions)	Gefilterde verbindingen uit meerdere groepen verwijderen
removeUserFromAllGroups(string, HubCloseConnectionOptions)	Een specifieke gebruiker verwijderen uit alle groepen waaraan ze lid zijn
revokePermission(string, Permission, HubRevokePermissionOptions)	Machtigingen van een verbinding intrekken
sendToAll(JSONTypes, HubSendToAllOptions)	Een JSON-bericht uitzenden naar alle verbindingen op deze hub.
sendToAll(RequestBodyType, HubSendToAllOptions)	Een binair bericht uitzenden naar alle verbindingen op deze hub.
sendToAll(string, HubSendTextToAllOptions)	Een sms-bericht uitzenden naar alle verbindingen op deze hub.
sendToConnection(string, JSONTypes, HubSendToConnectionOptions)	Een binair bericht verzenden naar een specifieke verbinding
sendToConnection(string, RequestBodyType, HubSendTextToConnectionOptions | HubSendToConnectionOptions)	Een binair bericht verzenden naar een specifieke verbinding
sendToConnection(string, string, HubSendTextToConnectionOptions)	Een sms-bericht verzenden naar een specifieke verbinding
sendToUser(string, JSONTypes, HubSendToUserOptions)	Een JSON-bericht verzenden naar een specifieke gebruiker
sendToUser(string, RequestBodyType, HubSendTextToUserOptions | HubSendToUserOptions)	Een binair bericht verzenden naar een specifieke gebruiker
sendToUser(string, string, HubSendTextToUserOptions)	Een sms-bericht verzenden naar een specifieke gebruiker
userExists(string, HubHasUserOptions)	Controleer of een bepaalde gebruiker is verbonden met deze hub.

Constructordetails

WebPubSubServiceClient(string, AzureKeyCredential | TokenCredential, string, WebPubSubServiceClientOptions)

Hiermee maakt u een exemplaar van een WebPubSubServiceClient voor het verzenden van berichten en het beheren van groepen, verbindingen en gebruikers.

Voorbeeldgebruik:

import { AzureKeyCredential, WebPubSubServiceClient } from "@azure/web-pubsub";

const key = new AzureKeyCredential("<Key>");
const serviceClient = new WebPubSubServiceClient("<Endpoint>", key, "<hubName>");

new WebPubSubServiceClient(endpoint: string, credential: AzureKeyCredential | TokenCredential, hubName: string, options?: WebPubSubServiceClientOptions)

Parameters

endpoint

string

Het eindpunt waarmee verbinding moet worden gemaakt

credential

AzureKeyCredential | TokenCredential

Een AzureKeyCredential met uw servicesleutel

hubName

string

De naam van de hub waarmee verbinding moet worden gemaakt.

options

WebPubSubServiceClientOptions

Opties voor het configureren van de HTTP-pijplijn

WebPubSubServiceClient(string, string, WebPubSubServiceClientOptions)

Hiermee maakt u een exemplaar van een WebPubSubServiceClient voor het verzenden van berichten en het beheren van groepen, verbindingen en gebruikers.

Voorbeeldgebruik:

import { WebPubSubServiceClient } from "@azure/web-pubsub";

const serviceClient = new WebPubSubServiceClient("<ConnectionString>", "<hubName>");

new WebPubSubServiceClient(connectionString: string, hubName: string, options?: WebPubSubServiceClientOptions)

Parameters

connectionString

string

De verbindingsreeks

hubName

string

De naam van de hub waarmee verbinding moet worden gemaakt. Als u dit weglaat, wordt '_default' gebruikt.

options

WebPubSubServiceClientOptions

Opties voor het configureren van de HTTP-pijplijn

Eigenschapdetails

apiVersion

De Web PubSub-API-versie die door deze client wordt gebruikt

apiVersion: string

Waarde van eigenschap

string

endpoint

Het Web PubSub-eindpunt waarop deze client is verbonden

endpoint: string

Waarde van eigenschap

string

hubName

De naam van de hub waarop deze client is verbonden

hubName: string

Waarde van eigenschap

string

Methodedetails

addConnectionsToGroups(string[], string, GroupAddConnectionOptions)

Gefilterde verbindingen toevoegen aan meerdere groepen

function addConnectionsToGroups(groups: string[], filter: string, options?: GroupAddConnectionOptions): Promise<void>

Parameters

groups

string[]

Een lijst met groepen waaraan doelverbindingen worden toegevoegd

filter

string

Een OData-filter waaraan doelverbindingen voldoen

options

GroupAddConnectionOptions

Aanvullende opties

Retouren

Promise<void>

closeAllConnections(HubCloseAllConnectionsOptions)

Alle verbindingen met deze hub sluiten

function closeAllConnections(options?: HubCloseAllConnectionsOptions): Promise<void>

Parameters

options

HubCloseAllConnectionsOptions

Aanvullende opties

Retouren

Promise<void>

closeConnection(string, HubCloseConnectionOptions)

Een specifieke verbinding met deze hub sluiten

function closeConnection(connectionId: string, options?: HubCloseConnectionOptions): Promise<void>

Parameters

connectionId

string

Verbindings-id om te sluiten

options

HubCloseConnectionOptions

Aanvullende opties

Retouren

Promise<void>

closeUserConnections(string, HubCloseUserConnectionsOptions)

Alle verbindingen met de opgegeven gebruikers-id sluiten

function closeUserConnections(userId: string, options?: HubCloseUserConnectionsOptions): Promise<void>

Parameters

userId

string

options

HubCloseUserConnectionsOptions

Aanvullende opties

Retouren

Promise<void>

connectionExists(string, HasConnectionOptions)

Controleer of een specifieke verbinding is verbonden met deze hub

function connectionExists(connectionId: string, options?: HasConnectionOptions): Promise<boolean>

Parameters

connectionId

string

Verbindings-id om te controleren

options

HasConnectionOptions

Aanvullende opties

Retouren

Promise<boolean>

getClientAccessToken(GenerateClientTokenOptions)

Genereer een token voor een client om verbinding te maken met de Azure Web PubSub-service.

function getClientAccessToken(options?: GenerateClientTokenOptions): Promise<ClientTokenResponse>

Parameters

options

GenerateClientTokenOptions

Aanvullende opties

Retouren

Promise<ClientTokenResponse>

grantPermission(string, Permission, HubGrantPermissionOptions)

Machtigingen verlenen aan een verbinding

function grantPermission(connectionId: string, permission: Permission, options?: HubGrantPermissionOptions): Promise<void>

Parameters

connectionId

string

De verbindings-id voor het verlenen van machtigingen aan

permission

Permission

options

HubGrantPermissionOptions

Aanvullende opties

Retouren

Promise<void>

group(string)

Een client voor een groep ophalen

function group(groupName: string): WebPubSubGroup

Parameters

groupName

string

De naam van de groep waarmee verbinding moet worden gemaakt.

Retouren

WebPubSubGroup

groupExists(string, HubHasGroupOptions)

Controleer of er een bepaalde groep bestaat (bijvoorbeeld actieve verbindingen).

function groupExists(groupName: string, options?: HubHasGroupOptions): Promise<boolean>

Parameters

groupName

string

De groepsnaam die moet worden gecontroleerd op

options

HubHasGroupOptions

Aanvullende opties

Retouren

Promise<boolean>

hasPermission(string, Permission, HubHasPermissionOptions)

Controleer of de verbinding de opgegeven machtiging heeft

function hasPermission(connectionId: string, permission: Permission, options?: HubHasPermissionOptions): Promise<boolean>

Parameters

connectionId

string

De verbindings-id om de machtiging te controleren

permission

Permission

options

HubHasPermissionOptions

Aanvullende opties

Retouren

Promise<boolean>

removeConnectionFromAllGroups(string, HubCloseConnectionOptions)

Een specifieke verbinding verwijderen uit alle groepen waaraan ze lid zijn

function removeConnectionFromAllGroups(connectionId: string, options?: HubCloseConnectionOptions): Promise<void>

Parameters

connectionId

string

De verbindings-id die uit alle groepen moet worden verwijderd

options

HubCloseConnectionOptions

Aanvullende opties

Retouren

Promise<void>

removeConnectionsFromGroups(string[], string, GroupRemoveConnectionOptions)

Gefilterde verbindingen uit meerdere groepen verwijderen

function removeConnectionsFromGroups(groups: string[], filter: string, options?: GroupRemoveConnectionOptions): Promise<void>

Parameters

groups

string[]

Een lijst met groepen waaruit doelverbindingen worden verwijderd

filter

string

Een OData-filter waaraan doelverbindingen voldoen

options

GroupRemoveConnectionOptions

Aanvullende opties

Retouren

Promise<void>

removeUserFromAllGroups(string, HubCloseConnectionOptions)

Een specifieke gebruiker verwijderen uit alle groepen waaraan ze lid zijn

function removeUserFromAllGroups(userId: string, options?: HubCloseConnectionOptions): Promise<void>

Parameters

userId

string

De gebruikers-id die uit alle groepen moet worden verwijderd

options

HubCloseConnectionOptions

Aanvullende opties

Retouren

Promise<void>

revokePermission(string, Permission, HubRevokePermissionOptions)

Machtigingen van een verbinding intrekken

function revokePermission(connectionId: string, permission: Permission, options?: HubRevokePermissionOptions): Promise<void>

Parameters

connectionId

string

De verbindings-id voor het intrekken van machtigingen van

permission

Permission

options

HubRevokePermissionOptions

Aanvullende opties

Retouren

Promise<void>

sendToAll(JSONTypes, HubSendToAllOptions)

Een JSON-bericht uitzenden naar alle verbindingen op deze hub.

function sendToAll(message: JSONTypes, options?: HubSendToAllOptions): Promise<void>

Parameters

message

JSONTypes

Het JSON-bericht dat moet worden verzonden

options

HubSendToAllOptions

Aanvullende opties

Retouren

Promise<void>

sendToAll(RequestBodyType, HubSendToAllOptions)

Een binair bericht uitzenden naar alle verbindingen op deze hub.

function sendToAll(message: RequestBodyType, options?: HubSendToAllOptions): Promise<void>

Parameters

message

RequestBodyType

Het bericht dat moet worden verzonden

options

HubSendToAllOptions

Aanvullende opties

Retouren

Promise<void>

sendToAll(string, HubSendTextToAllOptions)

Een sms-bericht uitzenden naar alle verbindingen op deze hub.

function sendToAll(message: string, options: HubSendTextToAllOptions): Promise<void>

Parameters

message

string

Het sms-bericht dat moet worden verzonden

options

HubSendTextToAllOptions

Aanvullende opties

Retouren

Promise<void>

sendToConnection(string, JSONTypes, HubSendToConnectionOptions)

Een binair bericht verzenden naar een specifieke verbinding

function sendToConnection(connectionId: string, message: JSONTypes, options?: HubSendToConnectionOptions): Promise<void>

Parameters

connectionId

string

Verbindings-id om naar te verzenden

message

JSONTypes

Het JSON-bericht

options

HubSendToConnectionOptions

Aanvullende opties

Retouren

Promise<void>

sendToConnection(string, RequestBodyType, HubSendTextToConnectionOptions | HubSendToConnectionOptions)

Een binair bericht verzenden naar een specifieke verbinding

function sendToConnection(connectionId: string, message: RequestBodyType, options?: HubSendTextToConnectionOptions | HubSendToConnectionOptions): Promise<void>

Parameters

connectionId

string

Verbindings-id om naar te verzenden

message

RequestBodyType

Het binaire bericht

options

HubSendTextToConnectionOptions | HubSendToConnectionOptions

Aanvullende opties

Retouren

Promise<void>

sendToConnection(string, string, HubSendTextToConnectionOptions)

Een sms-bericht verzenden naar een specifieke verbinding

function sendToConnection(connectionId: string, message: string, options: HubSendTextToConnectionOptions): Promise<void>

Parameters

connectionId

string

Verbindings-id om naar te verzenden

message

string

Het tekstbericht

options

HubSendTextToConnectionOptions

Aanvullende opties

Retouren

Promise<void>

sendToUser(string, JSONTypes, HubSendToUserOptions)

Een JSON-bericht verzenden naar een specifieke gebruiker

function sendToUser(username: string, message: JSONTypes, options?: HubSendToUserOptions): Promise<void>

Parameters

username

string

Gebruikersnaam voor verzenden naar

message

JSONTypes

Het josn-bericht dat moet worden verzonden

options

HubSendToUserOptions

Aanvullende opties

Retouren

Promise<void>

sendToUser(string, RequestBodyType, HubSendTextToUserOptions | HubSendToUserOptions)

Een binair bericht verzenden naar een specifieke gebruiker

function sendToUser(username: string, message: RequestBodyType, options?: HubSendTextToUserOptions | HubSendToUserOptions): Promise<void>

Parameters

username

string

De gebruikersnaam die moet worden verzonden naar

message

RequestBodyType

Het binaire bericht dat moet worden verzonden

options

HubSendTextToUserOptions | HubSendToUserOptions

Aanvullende opties

Retouren

Promise<void>

sendToUser(string, string, HubSendTextToUserOptions)

Een sms-bericht verzenden naar een specifieke gebruiker

function sendToUser(username: string, message: string, options: HubSendTextToUserOptions): Promise<void>

Parameters

username

string

Gebruikersnaam voor verzenden naar

message

string

Het sms-bericht dat moet worden verzonden

options

HubSendTextToUserOptions

Aanvullende opties

Retouren

Promise<void>

userExists(string, HubHasUserOptions)

Controleer of een bepaalde gebruiker is verbonden met deze hub.

function userExists(username: string, options?: HubHasUserOptions): Promise<boolean>

Parameters

username

string

De gebruikersnaam die moet worden gecontroleerd op

options

HubHasUserOptions

Aanvullende opties

Retouren

Promise<boolean>