From 7820137ad524c40bd09c70ddbd0c71cdef9a0a57 Mon Sep 17 00:00:00 2001 From: Brennan Date: Fri, 28 Jun 2019 15:27:25 -0700 Subject: [PATCH] Add xml comments to HubInvocationContext (#11683) --- .../server/Core/src/HubInvocationContext.cs | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/src/SignalR/server/Core/src/HubInvocationContext.cs b/src/SignalR/server/Core/src/HubInvocationContext.cs index 9cda75da11..a62706d6a8 100644 --- a/src/SignalR/server/Core/src/HubInvocationContext.cs +++ b/src/SignalR/server/Core/src/HubInvocationContext.cs @@ -2,11 +2,21 @@ // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. using System.Collections.Generic; +using Microsoft.AspNetCore.Authorization; namespace Microsoft.AspNetCore.SignalR { + /// + /// Context for a Hub invocation. + /// public class HubInvocationContext { + /// + /// Instantiates a new instance of the class. + /// + /// Context for the active Hub connection and caller. + /// The name of the Hub method being invoked. + /// The arguments provided by the client. public HubInvocationContext(HubCallerContext context, string hubMethodName, object[] hubMethodArguments) { HubMethodName = hubMethodName; @@ -14,8 +24,19 @@ namespace Microsoft.AspNetCore.SignalR Context = context; } + /// + /// Gets the context for the active Hub connection and caller. + /// public HubCallerContext Context { get; } + + /// + /// Gets the name of the Hub method being invoked. + /// public string HubMethodName { get; } + + /// + /// Gets the arguments provided by the client. + /// public IReadOnlyList HubMethodArguments { get; } } }