Skip to content

Commit 7820137

Browse files
Add xml comments to HubInvocationContext (#11683)
1 parent 3cb414a commit 7820137

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

src/SignalR/server/Core/src/HubInvocationContext.cs

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,41 @@
22
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
33

44
using System.Collections.Generic;
5+
using Microsoft.AspNetCore.Authorization;
56

67
namespace Microsoft.AspNetCore.SignalR
78
{
9+
/// <summary>
10+
/// Context for a Hub invocation.
11+
/// </summary>
812
public class HubInvocationContext
913
{
14+
/// <summary>
15+
/// Instantiates a new instance of the <see cref="HubInvocationContext"/> class.
16+
/// </summary>
17+
/// <param name="context">Context for the active Hub connection and caller.</param>
18+
/// <param name="hubMethodName">The name of the Hub method being invoked.</param>
19+
/// <param name="hubMethodArguments">The arguments provided by the client.</param>
1020
public HubInvocationContext(HubCallerContext context, string hubMethodName, object[] hubMethodArguments)
1121
{
1222
HubMethodName = hubMethodName;
1323
HubMethodArguments = hubMethodArguments;
1424
Context = context;
1525
}
1626

27+
/// <summary>
28+
/// Gets the context for the active Hub connection and caller.
29+
/// </summary>
1730
public HubCallerContext Context { get; }
31+
32+
/// <summary>
33+
/// Gets the name of the Hub method being invoked.
34+
/// </summary>
1835
public string HubMethodName { get; }
36+
37+
/// <summary>
38+
/// Gets the arguments provided by the client.
39+
/// </summary>
1940
public IReadOnlyList<object> HubMethodArguments { get; }
2041
}
2142
}

0 commit comments

Comments
 (0)