aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/csharp/Grpc.Auth/AuthInterceptors.cs
diff options
context:
space:
mode:
authorGravatar Hongyu Chen <hongyu@google.com>2015-08-25 14:44:15 -0700
committerGravatar Hongyu Chen <hongyu@google.com>2015-08-25 14:44:15 -0700
commit011ea49592e71e1db3ef43a094aa9b452ff21e67 (patch)
tree70017b24ed2d3736552025680d4a0f138adf456f /src/csharp/Grpc.Auth/AuthInterceptors.cs
parenta96ce800a8df5c62ffd264317836ecf3433c4344 (diff)
parent1b481b64be43bd4c7655b25422344a17b2f198d9 (diff)
Merge remote-tracking branch 'upstream/master' into timespec
Diffstat (limited to 'src/csharp/Grpc.Auth/AuthInterceptors.cs')
-rw-r--r--src/csharp/Grpc.Auth/AuthInterceptors.cs6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/csharp/Grpc.Auth/AuthInterceptors.cs b/src/csharp/Grpc.Auth/AuthInterceptors.cs
index 61338f7f0e..c8ab4d9af6 100644
--- a/src/csharp/Grpc.Auth/AuthInterceptors.cs
+++ b/src/csharp/Grpc.Auth/AuthInterceptors.cs
@@ -41,7 +41,8 @@ using Grpc.Core.Utils;
namespace Grpc.Auth
{
/// <summary>
- /// Factory methods to create authorization interceptors.
+ /// Factory methods to create authorization interceptors. Interceptors created can be registered with gRPC client classes (autogenerated client stubs that
+ /// inherit from <see cref="Grpc.Core.ClientBase"/>).
/// </summary>
public static class AuthInterceptors
{
@@ -52,6 +53,8 @@ namespace Grpc.Auth
/// Creates interceptor that will obtain access token from any credential type that implements
/// <c>ITokenAccess</c>. (e.g. <c>GoogleCredential</c>).
/// </summary>
+ /// <param name="credential">The credential to use to obtain access tokens.</param>
+ /// <returns>The header interceptor.</returns>
public static HeaderInterceptor FromCredential(ITokenAccess credential)
{
return new HeaderInterceptor((method, authUri, metadata) =>
@@ -67,6 +70,7 @@ namespace Grpc.Auth
/// Creates OAuth2 interceptor that will use given access token as authorization.
/// </summary>
/// <param name="accessToken">OAuth2 access token.</param>
+ /// <returns>The header interceptor.</returns>
public static HeaderInterceptor FromAccessToken(string accessToken)
{
Preconditions.CheckNotNull(accessToken);