Add xml comments to HubInvocationContext (#11683)

This commit is contained in:
Brennan 2019-06-28 15:27:25 -07:00 committed by GitHub
parent 3cb414afdc
commit 7820137ad5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 0 deletions

View File

@ -2,11 +2,21 @@
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
using System.Collections.Generic; using System.Collections.Generic;
using Microsoft.AspNetCore.Authorization;
namespace Microsoft.AspNetCore.SignalR namespace Microsoft.AspNetCore.SignalR
{ {
/// <summary>
/// Context for a Hub invocation.
/// </summary>
public class HubInvocationContext public class HubInvocationContext
{ {
/// <summary>
/// Instantiates a new instance of the <see cref="HubInvocationContext"/> class.
/// </summary>
/// <param name="context">Context for the active Hub connection and caller.</param>
/// <param name="hubMethodName">The name of the Hub method being invoked.</param>
/// <param name="hubMethodArguments">The arguments provided by the client.</param>
public HubInvocationContext(HubCallerContext context, string hubMethodName, object[] hubMethodArguments) public HubInvocationContext(HubCallerContext context, string hubMethodName, object[] hubMethodArguments)
{ {
HubMethodName = hubMethodName; HubMethodName = hubMethodName;
@ -14,8 +24,19 @@ namespace Microsoft.AspNetCore.SignalR
Context = context; Context = context;
} }
/// <summary>
/// Gets the context for the active Hub connection and caller.
/// </summary>
public HubCallerContext Context { get; } public HubCallerContext Context { get; }
/// <summary>
/// Gets the name of the Hub method being invoked.
/// </summary>
public string HubMethodName { get; } public string HubMethodName { get; }
/// <summary>
/// Gets the arguments provided by the client.
/// </summary>
public IReadOnlyList<object> HubMethodArguments { get; } public IReadOnlyList<object> HubMethodArguments { get; }
} }
} }