@azure/web-pubsub package

Kelas

AzureKeyCredential	Kredensial berbasis kunci statis yang mendukung pembaruan nilai kunci yang mendasar.
WebPubSubServiceClient	Klien untuk menyambungkan ke hub Web PubSub

Antarmuka

ClientTokenResponse	Respons yang berisi token klien.
GenerateClientTokenOptions	Opsi untuk menghasilkan token untuk menyambungkan klien ke layanan Azure Web Pubsub.
GroupAddConnectionOptions	Opsi untuk menambahkan koneksi ke grup.
GroupAddUserOptions	Opsi untuk menambahkan pengguna ke grup.
GroupAdminClientOptions	Opsi untuk membuat klien GroupAdmin.
GroupCloseAllConnectionsOptions	Opsi untuk menutup semua koneksi ke grup.
GroupHasUserOptions	Opsi untuk memeriksa apakah pengguna berada dalam grup
GroupListConnectionsOptions	Opsi untuk mencantumkan koneksi dalam grup.
GroupRemoveConnectionOptions	Opsi untuk menghapus koneksi dari grup
GroupRemoveUserOptions	Opsi untuk menghapus pengguna dari grup
GroupSendTextToAllOptions	Opsi untuk mengirim pesan teks ke grup..
GroupSendToAllOptions	Opsi untuk mengirim pesan ke grup.
HasConnectionOptions	Opsi untuk memeriksa apakah ada koneksi.
HubCloseAllConnectionsOptions	Opsi untuk menutup semua koneksi ke hub.
HubCloseConnectionOptions	Opsi untuk menutup koneksi ke hub.
HubCloseUserConnectionsOptions	Opsi untuk menutup semua koneksi pengguna ke hub.
HubGrantPermissionOptions	Opsi untuk memberikan izin ke koneksi
HubHasGroupOptions	Opsi untuk memeriksa apakah ada grup.
HubHasPermissionOptions	Opsi untuk memeriksa apakah koneksi memiliki izin yang ditentukan
HubHasUserOptions	Opsi untuk memeriksa apakah pengguna ada.
HubRemoveUserFromAllGroupsOptions	Opsi untuk menghapus pengguna dari semua grup.
HubRevokePermissionOptions	Opsi untuk mencabut izin dari koneksi
HubSendTextToAllOptions	Opsi untuk mengirim pesan teks ke hub.
HubSendTextToConnectionOptions	Opsi untuk mengirim pesan teks ke koneksi.
HubSendTextToUserOptions	Opsi untuk mengirim pesan teks ke pengguna.
HubSendToAllOptions	Opsi untuk mengirim pesan ke hub.
HubSendToConnectionOptions	Opsi untuk mengirim pesan ke koneksi tertentu.
HubSendToUserOptions	Opsi untuk mengirim pesan ke pengguna.
WebPubSubGroup
WebPubSubGroupMember	Koneksi dalam grup di layanan Web PubSub.
WebPubSubServiceClientLogOptions	Opsi untuk mengonfigurasi opsi pengelogan.
WebPubSubServiceClientOptions	Opsi untuk membangun klien HubAdmin.

Alias Jenis

JSONTypes	Jenis yang dapat diserialisasikan dan dikirim sebagai JSON.
Permission
WebPubSubClientProtocol	Jenis titik akhir klien yang diminta.

Fungsi

odata(TemplateStringsArray, unknown[])

Lolos dari ekspresi filter odata untuk menghindari kesalahan dengan mengutip literal string. Contoh penggunaan:

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

const userId = "vic's";
const anonymous = null;
const length = 3;
const filter = odata`userId eq ${anonymous} or userId eq ${userId} or length(userId) > ${length}`;

Detail Fungsi

odata(TemplateStringsArray, unknown[])

Lolos dari ekspresi filter odata untuk menghindari kesalahan dengan mengutip literal string. Contoh penggunaan:

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

const userId = "vic's";
const anonymous = null;
const length = 3;
const filter = odata`userId eq ${anonymous} or userId eq ${userId} or length(userId) > ${length}`;

function odata(strings: TemplateStringsArray, values: unknown[]): string

Parameter

strings: TemplateStringsArray

Array string untuk ekspresi

values: unknown[]

Array nilai untuk ekspresi

Mengembalikan

string