.packages/microsoft.aspnetcore.app.ref/3.0.1/ref/netcoreapp3.0/Microsoft.AspNetCore.SignalR.xml


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Microsoft.AspNetCore.SignalR</name>
    </assembly>
    <members>
        <member name="T:Microsoft.AspNetCore.SignalR.GetHttpContextExtensions">
            <summary>
            Extension methods for accessing <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> from a hub context.
            </summary>
        </member>
        <member name="M:Microsoft.AspNetCore.SignalR.GetHttpContextExtensions.GetHttpContext(Microsoft.AspNetCore.SignalR.HubCallerContext)">
            <summary>
            Gets <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> from the specified connection, or <c>null</c> if the connection is not associated with an HTTP request.
            </summary>
            <param name="connection">The connection.</param>
            <returns>The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> for the connection, or <c>null</c> if the connection is not associated with an HTTP request.</returns>
        </member>
        <member name="M:Microsoft.AspNetCore.SignalR.GetHttpContextExtensions.GetHttpContext(Microsoft.AspNetCore.SignalR.HubConnectionContext)">
            <summary>
            Gets <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> from the specified connection, or <c>null</c> if the connection is not associated with an HTTP request.
            </summary>
            <param name="connection">The connection.</param>
            <returns>The <see cref="T:Microsoft.AspNetCore.Http.HttpContext"/> for the connection, or <c>null</c> if the connection is not associated with an HTTP request.</returns>
        </member>
        <member name="T:Microsoft.AspNetCore.SignalR.HubRouteBuilder">
            <summary>
            Maps incoming requests to <see cref="T:Microsoft.AspNetCore.SignalR.Hub"/> types.
            <para>
                This class is obsolete and will be removed in a future version.
                The recommended alternative is to use MapHub&#60;THub&#62; inside Microsoft.AspNetCore.Builder.UseEndpoints(...).
            </para>
            </summary>
        </member>
        <member name="M:Microsoft.AspNetCore.SignalR.HubRouteBuilder.#ctor(Microsoft.AspNetCore.Http.Connections.ConnectionsRouteBuilder)">
            <summary>
            Initializes a new instance of the <see cref="T:Microsoft.AspNetCore.SignalR.HubRouteBuilder"/> class.
            </summary>
            <param name="routes">The routes builder.</param>
        </member>
        <member name="M:Microsoft.AspNetCore.SignalR.HubRouteBuilder.MapHub``1(Microsoft.AspNetCore.Http.PathString)">
            <summary>
            Maps incoming requests with the specified path to the specified <see cref="T:Microsoft.AspNetCore.SignalR.Hub"/> type.
            </summary>
            <typeparam name="THub">The <see cref="T:Microsoft.AspNetCore.SignalR.Hub"/> type to map requests to.</typeparam>
            <param name="path">The request path.</param>
        </member>
        <member name="M:Microsoft.AspNetCore.SignalR.HubRouteBuilder.MapHub``1(Microsoft.AspNetCore.Http.PathString,System.Action{Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions})">
            <summary>
            Maps incoming requests with the specified path to the specified <see cref="T:Microsoft.AspNetCore.SignalR.Hub"/> type.
            </summary>
            <typeparam name="THub">The <see cref="T:Microsoft.AspNetCore.SignalR.Hub"/> type to map requests to.</typeparam>
            <param name="path">The request path.</param>
            <param name="configureOptions">A callback to configure dispatcher options.</param>
        </member>
        <member name="T:Microsoft.AspNetCore.Builder.HubEndpointConventionBuilder">
            <summary>
            Builds conventions that will be used for customization of Hub <see cref="T:Microsoft.AspNetCore.Builder.EndpointBuilder"/> instances.
            </summary>
        </member>
        <member name="M:Microsoft.AspNetCore.Builder.HubEndpointConventionBuilder.Add(System.Action{Microsoft.AspNetCore.Builder.EndpointBuilder})">
            <summary>
            Adds the specified convention to the builder. Conventions are used to customize <see cref="T:Microsoft.AspNetCore.Builder.EndpointBuilder"/> instances.
            </summary>
            <param name="convention">The convention to add to the builder.</param>
        </member>
        <member name="M:Microsoft.AspNetCore.Builder.HubEndpointRouteBuilderExtensions.MapHub``1(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.String)">
            <summary>
            Maps incoming requests with the specified path to the specified <see cref="T:Microsoft.AspNetCore.SignalR.Hub"/> type.
            </summary>
            <typeparam name="THub">The <see cref="T:Microsoft.AspNetCore.SignalR.Hub"/> type to map requests to.</typeparam>
            <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/> to add the route to.</param>
            <param name="pattern">The route pattern.</param>
            <returns>An <see cref="T:Microsoft.AspNetCore.Builder.HubEndpointConventionBuilder"/> for endpoints associated with the connections.</returns>
        </member>
        <member name="M:Microsoft.AspNetCore.Builder.HubEndpointRouteBuilderExtensions.MapHub``1(Microsoft.AspNetCore.Routing.IEndpointRouteBuilder,System.String,System.Action{Microsoft.AspNetCore.Http.Connections.HttpConnectionDispatcherOptions})">
            <summary>
            Maps incoming requests with the specified path to the specified <see cref="T:Microsoft.AspNetCore.SignalR.Hub"/> type.
            </summary>
            <typeparam name="THub">The <see cref="T:Microsoft.AspNetCore.SignalR.Hub"/> type to map requests to.</typeparam>
            <param name="endpoints">The <see cref="T:Microsoft.AspNetCore.Routing.IEndpointRouteBuilder"/> to add the route to.</param>
            <param name="pattern">The route pattern.</param>
            <param name="configureOptions">A callback to configure dispatcher options.</param>
            <returns>An <see cref="T:Microsoft.AspNetCore.Builder.HubEndpointConventionBuilder"/> for endpoints associated with the connections.</returns>
        </member>
        <member name="T:Microsoft.AspNetCore.Builder.IHubEndpointConventionBuilder">
            <summary>
            Abstraction that builds conventions that will be used for customization of Hub <see cref="T:Microsoft.AspNetCore.Builder.EndpointBuilder"/> instances.
            </summary>
        </member>
        <member name="T:Microsoft.AspNetCore.Builder.SignalRAppBuilderExtensions">
            <summary>
            Extension methods for <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.
            </summary>
        </member>
        <member name="M:Microsoft.AspNetCore.Builder.SignalRAppBuilderExtensions.UseSignalR(Microsoft.AspNetCore.Builder.IApplicationBuilder,System.Action{Microsoft.AspNetCore.SignalR.HubRouteBuilder})">
            <summary>
            Adds SignalR to the <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> request execution pipeline.
            <para>
                This method is obsolete and will be removed in a future version.
                The recommended alternative is to use MapHub&#60;THub&#62; inside Microsoft.AspNetCore.Builder.UseEndpoints(...).
            </para>
            </summary>
            <param name="app">The <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/>.</param>
            <param name="configure">A callback to configure hub routes.</param>
            <returns>The same instance of the <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder"/> for chaining.</returns>
        </member>
        <member name="T:Microsoft.Extensions.DependencyInjection.SignalRDependencyInjectionExtensions">
            <summary>
            Extension methods for setting up SignalR services in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
            </summary>
        </member>
        <member name="M:Microsoft.Extensions.DependencyInjection.SignalRDependencyInjectionExtensions.AddHubOptions``1(Microsoft.AspNetCore.SignalR.ISignalRServerBuilder,System.Action{Microsoft.AspNetCore.SignalR.HubOptions{``0}})">
            <summary>
            Adds hub specific options to an <see cref="T:Microsoft.AspNetCore.SignalR.ISignalRServerBuilder"/>.
            </summary>
            <typeparam name="THub">The hub type to configure.</typeparam>
            <param name="signalrBuilder">The <see cref="T:Microsoft.AspNetCore.SignalR.ISignalRServerBuilder"/>.</param>
            <param name="configure">A callback to configure the hub options.</param>
            <returns>The same instance of the <see cref="T:Microsoft.AspNetCore.SignalR.ISignalRServerBuilder"/> for chaining.</returns>
        </member>
        <member name="M:Microsoft.Extensions.DependencyInjection.SignalRDependencyInjectionExtensions.AddSignalR(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
            <summary>
            Adds SignalR services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
            </summary>
            <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
            <returns>An <see cref="T:Microsoft.AspNetCore.SignalR.ISignalRServerBuilder"/> that can be used to further configure the SignalR services.</returns>
        </member>
        <member name="M:Microsoft.Extensions.DependencyInjection.SignalRDependencyInjectionExtensions.AddSignalR(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Microsoft.AspNetCore.SignalR.HubOptions})">
            <summary>
            Adds SignalR services to the specified <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" />.
            </summary>
            <param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> to add services to.</param>
            <param name="configure">An <see cref="T:System.Action`1"/> to configure the provided <see cref="T:Microsoft.AspNetCore.SignalR.HubOptions"/>.</param>
            <returns>An <see cref="T:Microsoft.AspNetCore.SignalR.ISignalRServerBuilder"/> that can be used to further configure the SignalR services.</returns>
        </member>
    </members>
</doc>