sphinx webpubsub (#36112)
This commit is contained in:
Родитель
c87035431b
Коммит
9feff400e6
|
@ -583,6 +583,7 @@ class WebPubSubClient(
|
|||
**kwargs: Any,
|
||||
) -> None:
|
||||
"""Send message to group.
|
||||
|
||||
:param group_name: The group name. Required.
|
||||
:type group_name: str.
|
||||
:param content: The data content. Required.
|
||||
|
@ -604,6 +605,7 @@ class WebPubSubClient(
|
|||
**kwargs: Any,
|
||||
) -> None:
|
||||
"""Send message to group.
|
||||
|
||||
:param group_name: The group name. Required.
|
||||
:type group_name: str.
|
||||
:param content: The data content. Required.
|
||||
|
@ -625,6 +627,7 @@ class WebPubSubClient(
|
|||
**kwargs: Any,
|
||||
) -> None:
|
||||
"""Send message to group.
|
||||
|
||||
:param group_name: The group name. Required.
|
||||
:type group_name: str.
|
||||
:param content: The data content. Required.
|
||||
|
@ -646,6 +649,7 @@ class WebPubSubClient(
|
|||
**kwargs: Any,
|
||||
) -> None:
|
||||
"""Send message to group.
|
||||
|
||||
:param group_name: The group name. Required.
|
||||
:type group_name: str.
|
||||
:param content: The data content. Required.
|
||||
|
|
|
@ -498,6 +498,7 @@ class WebPubSubClient(
|
|||
**kwargs: Any,
|
||||
) -> None:
|
||||
"""Send message to group.
|
||||
|
||||
:param group_name: The group name. Required.
|
||||
:type group_name: str.
|
||||
:param content: The data content. Required.
|
||||
|
@ -519,6 +520,7 @@ class WebPubSubClient(
|
|||
**kwargs: Any,
|
||||
) -> None:
|
||||
"""Send message to group.
|
||||
|
||||
:param group_name: The group name. Required.
|
||||
:type group_name: str.
|
||||
:param content: The data content. Required.
|
||||
|
@ -540,6 +542,7 @@ class WebPubSubClient(
|
|||
**kwargs: Any,
|
||||
) -> None:
|
||||
"""Send message to group.
|
||||
|
||||
:param group_name: The group name. Required.
|
||||
:type group_name: str.
|
||||
:param content: The data content. Required.
|
||||
|
@ -561,6 +564,7 @@ class WebPubSubClient(
|
|||
**kwargs: Any,
|
||||
) -> None:
|
||||
"""Send message to group.
|
||||
|
||||
:param group_name: The group name. Required.
|
||||
:type group_name: str.
|
||||
:param content: The data content. Required.
|
||||
|
|
|
@ -3,3 +3,4 @@ pylint = false
|
|||
pyright = false
|
||||
type_check_samples = false
|
||||
verifytypes = false
|
||||
strict_sphinx = true
|
||||
|
|
|
@ -82,6 +82,7 @@ class WebPubSubServiceClientOperationsMixin(WebPubSubServiceClientOperationsMixi
|
|||
@distributed_trace
|
||||
def get_client_access_token(self, **kwargs: Any) -> JSON:
|
||||
"""Build an authentication token.
|
||||
|
||||
:keyword user_id: User Id.
|
||||
:paramtype user_id: str
|
||||
:keyword roles: Roles that the connection with the generated token will have.
|
||||
|
@ -93,13 +94,15 @@ class WebPubSubServiceClientOperationsMixin(WebPubSubServiceClientOperationsMixi
|
|||
:paramtype groups: list[str]
|
||||
:returns: JSON response containing the web socket endpoint, the token and a url with the generated access token.
|
||||
:rtype: JSON
|
||||
|
||||
Example:
|
||||
>>> get_client_access_token()
|
||||
{
|
||||
'baseUrl': 'wss://contoso.com/api/webpubsub/client/hubs/theHub',
|
||||
'token': '<access-token>...',
|
||||
'url': 'wss://contoso.com/api/webpubsub/client/hubs/theHub?access_token=<access-token>...'
|
||||
}
|
||||
|
||||
>>> get_client_access_token()
|
||||
{
|
||||
'baseUrl': 'wss://contoso.com/api/webpubsub/client/hubs/theHub',
|
||||
'token': '<access-token>...',
|
||||
'url': 'wss://contoso.com/api/webpubsub/client/hubs/theHub?access_token=<access-token>...'
|
||||
}
|
||||
"""
|
||||
endpoint = self._config.endpoint.lower()
|
||||
if not endpoint.startswith("http://") and not endpoint.startswith("https://"):
|
||||
|
|
|
@ -42,7 +42,7 @@ class WebPubSubServiceClientOperationsMixin(WebPubSubServiceClientOperationsMixi
|
|||
**kwargs: Any
|
||||
) -> JSON:
|
||||
"""Generate token for the client to connect Azure Web PubSub service.
|
||||
Generate token for the client to connect Azure Web PubSub service.
|
||||
|
||||
:keyword user_id: User Id.
|
||||
:paramtype user_id: str
|
||||
:keyword roles: Roles that the connection with the generated token will have.
|
||||
|
@ -58,8 +58,9 @@ class WebPubSubServiceClientOperationsMixin(WebPubSubServiceClientOperationsMixi
|
|||
:return: JSON object
|
||||
:rtype: JSON
|
||||
:raises: ~azure.core.exceptions.HttpResponseError
|
||||
|
||||
Example:
|
||||
.. code-block:: python
|
||||
|
||||
>>> get_client_access_token()
|
||||
{
|
||||
'baseUrl': 'wss://contoso.com/api/webpubsub/client/hubs/theHub',
|
||||
|
|
|
@ -2,3 +2,4 @@
|
|||
pylint = false
|
||||
pyright = false
|
||||
mypy = false
|
||||
strict_sphinx = true
|
||||
|
|
Загрузка…
Ссылка в новой задаче