aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/csharp/Grpc.Auth/AuthInterceptors.cs
diff options
context:
space:
mode:
authorGravatar Craig Tiller <craig.tiller@gmail.com>2015-08-26 10:58:17 -0700
committerGravatar Craig Tiller <craig.tiller@gmail.com>2015-08-26 10:58:17 -0700
commitc84d4aa6d08770335e1a5debbd2f3daff3897d19 (patch)
tree85522ef3c538391da9fc8e40c0b929f00f150c80 /src/csharp/Grpc.Auth/AuthInterceptors.cs
parent1dc323b45e1a109c860806cb25e7eca21c29a3c0 (diff)
parent60e0e743bed05b248c485949c6cd9e05fa02b607 (diff)
Merge github.com:grpc/grpc into endpoints
Conflicts: src/core/iomgr/tcp_windows.c
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);