@azure/web-pubsub package
Sınıflar
| AzureKeyCredential |
Temel alınan anahtar değerinin güncelleştirilmesini destekleyen statik anahtar tabanlı kimlik bilgileri. |
| WebPubSubServiceClient |
Web PubSub hub'ına bağlanmak için istemci |
Arabirimler
| ClientTokenResponse |
İstemci belirtecini içeren bir yanıt. |
| GenerateClientTokenOptions |
İstemciyi Azure Web Pubsub hizmetine bağlamak için belirteç oluşturma seçenekleri. |
| GroupAddConnectionOptions |
Gruba bağlantı ekleme seçenekleri. |
| GroupAddUserOptions |
Gruba kullanıcı ekleme seçenekleri. |
| GroupAdminClientOptions |
GroupAdmin istemcisi oluşturma seçenekleri. |
| GroupCloseAllConnectionsOptions |
Bir gruba yönelik tüm bağlantıları kapatma seçenekleri. |
| GroupHasUserOptions |
Kullanıcının grupta olup olmadığını denetleme seçenekleri |
| GroupListConnectionsOptions |
Bir gruptaki bağlantıları listeleme seçenekleri. |
| GroupRemoveConnectionOptions |
Gruptan bağlantı kaldırma seçenekleri |
| GroupRemoveUserOptions |
Bir kullanıcıyı gruptan kaldırma seçenekleri |
| GroupSendTextToAllOptions |
Gruba kısa mesaj gönderme seçenekleri.. |
| GroupSendToAllOptions |
Gruba ileti gönderme seçenekleri. |
| HasConnectionOptions |
Bağlantı olup olmadığını denetleme seçenekleri. |
| HubCloseAllConnectionsOptions |
Bir hub'a tüm bağlantıları kapatma seçenekleri. |
| HubCloseConnectionOptions |
Hub bağlantısını kapatma seçenekleri. |
| HubCloseUserConnectionsOptions |
Kullanıcının hub'a olan tüm bağlantılarını kapatma seçenekleri. |
| HubGrantPermissionOptions |
Bağlantıya izin verme seçenekleri |
| HubHasGroupOptions |
Grubun var olup olmadığını denetleme seçenekleri. |
| HubHasPermissionOptions |
Bağlantının belirtilen izne sahip olup olmadığını denetleme seçenekleri |
| HubHasUserOptions |
Kullanıcının var olup olmadığını denetleme seçenekleri. |
| HubRemoveUserFromAllGroupsOptions |
Bir kullanıcıyı tüm gruplardan kaldırma seçenekleri. |
| HubRevokePermissionOptions |
Bağlantıdan izinleri iptal etme seçenekleri |
| HubSendTextToAllOptions |
Hub'lara kısa mesaj gönderme seçenekleri. |
| HubSendTextToConnectionOptions |
Bağlantıya kısa mesaj gönderme seçenekleri. |
| HubSendTextToUserOptions |
Kullanıcıya kısa mesaj gönderme seçenekleri. |
| HubSendToAllOptions |
Hub'lara ileti gönderme seçenekleri. |
| HubSendToConnectionOptions |
Belirli bir bağlantıya ileti gönderme seçenekleri. |
| HubSendToUserOptions |
Kullanıcıya ileti gönderme seçenekleri. |
| WebPubSubGroup | |
| WebPubSubGroupMember |
Web PubSub hizmetindeki bir grupta yer alan bir bağlantı. |
| WebPubSubServiceClientLogOptions |
Günlük seçeneklerini yapılandırma seçenekleri. |
| WebPubSubServiceClientOptions |
HubAdmin istemcisi oluşturma seçenekleri. |
Tür Diğer Adları
| JSONTypes |
Seri hale getirilebilen ve JSON olarak gönderilebilen türler. |
| Permission | |
| WebPubSubClientProtocol |
İstenen istemci uç noktasının türü. |
İşlevler
| odata(Template |
Dize değişmez değerlerinin alıntılanmasıyla ilgili hataları önlemek için odata filtre ifadelerinden kaçar. Örnek kullanım:
|
İşlev Ayrıntıları
odata(TemplateStringsArray, unknown[])
Dize değişmez değerlerinin alıntılanmasıyla ilgili hataları önlemek için odata filtre ifadelerinden kaçar. Örnek kullanım:
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
Parametreler
- strings
-
TemplateStringsArray
İfade için dize dizisi
- values
-
unknown[]
İfade için değer dizisi
Döndürülenler
string