Grpc.Core.CallCredentials.html 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class CallCredentials
  8. | gRPC for .NET </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class CallCredentials
  11. | gRPC for .NET ">
  12. <meta name="generator" content="docfx 2.36.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <meta property="docfx:navrel" content="../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../index.html">
  34. <img id="logo" class="svg" src="../logo.svg" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Grpc.Core.CallCredentials">
  73. <h1 id="Grpc_Core_CallCredentials" data-uid="Grpc.Core.CallCredentials" class="text-break">Class CallCredentials
  74. </h1>
  75. <div class="markdown level0 summary"><p>Client-side call credentials. Provide authorization with per-call granularity.</p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <div class="inheritance">
  79. <h5>Inheritance</h5>
  80. <div class="level0"><span class="xref">System.Object</span></div>
  81. <div class="level1"><span class="xref">CallCredentials</span></div>
  82. </div>
  83. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  84. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  85. <h5 id="Grpc_Core_CallCredentials_syntax">Syntax</h5>
  86. <div class="codewrapper">
  87. <pre><code class="lang-csharp hljs">public abstract class CallCredentials : object</code></pre>
  88. </div>
  89. <h3 id="methods">Methods
  90. </h3>
  91. <a id="Grpc_Core_CallCredentials_Compose_" data-uid="Grpc.Core.CallCredentials.Compose*"></a>
  92. <h4 id="Grpc_Core_CallCredentials_Compose_Grpc_Core_CallCredentials___" data-uid="Grpc.Core.CallCredentials.Compose(Grpc.Core.CallCredentials[])">Compose(CallCredentials[])</h4>
  93. <div class="markdown level1 summary"><p>Composes multiple multiple <code>CallCredentials</code> objects into
  94. a single <code>CallCredentials</code> object.</p>
  95. </div>
  96. <div class="markdown level1 conceptual"></div>
  97. <h5 class="decalaration">Declaration</h5>
  98. <div class="codewrapper">
  99. <pre><code class="lang-csharp hljs">public static CallCredentials Compose(params CallCredentials[] credentials)</code></pre>
  100. </div>
  101. <h5 class="parameters">Parameters</h5>
  102. <table class="table table-bordered table-striped table-condensed">
  103. <thead>
  104. <tr>
  105. <th>Type</th>
  106. <th>Name</th>
  107. <th>Description</th>
  108. </tr>
  109. </thead>
  110. <tbody>
  111. <tr>
  112. <td><a class="xref" href="Grpc.Core.CallCredentials.html">CallCredentials</a>[]</td>
  113. <td><span class="parametername">credentials</span></td>
  114. <td><p>credentials to compose</p>
  115. </td>
  116. </tr>
  117. </tbody>
  118. </table>
  119. <h5 class="returns">Returns</h5>
  120. <table class="table table-bordered table-striped table-condensed">
  121. <thead>
  122. <tr>
  123. <th>Type</th>
  124. <th>Description</th>
  125. </tr>
  126. </thead>
  127. <tbody>
  128. <tr>
  129. <td><a class="xref" href="Grpc.Core.CallCredentials.html">CallCredentials</a></td>
  130. <td><p>The new <code>CompositeCallCredentials</code></p>
  131. </td>
  132. </tr>
  133. </tbody>
  134. </table>
  135. <a id="Grpc_Core_CallCredentials_FromInterceptor_" data-uid="Grpc.Core.CallCredentials.FromInterceptor*"></a>
  136. <h4 id="Grpc_Core_CallCredentials_FromInterceptor_Grpc_Core_AsyncAuthInterceptor_" data-uid="Grpc.Core.CallCredentials.FromInterceptor(Grpc.Core.AsyncAuthInterceptor)">FromInterceptor(AsyncAuthInterceptor)</h4>
  137. <div class="markdown level1 summary"><p>Creates a new instance of <code>CallCredentials</code> class from an
  138. interceptor that can attach metadata to outgoing calls.</p>
  139. </div>
  140. <div class="markdown level1 conceptual"></div>
  141. <h5 class="decalaration">Declaration</h5>
  142. <div class="codewrapper">
  143. <pre><code class="lang-csharp hljs">public static CallCredentials FromInterceptor(AsyncAuthInterceptor interceptor)</code></pre>
  144. </div>
  145. <h5 class="parameters">Parameters</h5>
  146. <table class="table table-bordered table-striped table-condensed">
  147. <thead>
  148. <tr>
  149. <th>Type</th>
  150. <th>Name</th>
  151. <th>Description</th>
  152. </tr>
  153. </thead>
  154. <tbody>
  155. <tr>
  156. <td><a class="xref" href="Grpc.Core.AsyncAuthInterceptor.html">AsyncAuthInterceptor</a></td>
  157. <td><span class="parametername">interceptor</span></td>
  158. <td><p>authentication interceptor</p>
  159. </td>
  160. </tr>
  161. </tbody>
  162. </table>
  163. <h5 class="returns">Returns</h5>
  164. <table class="table table-bordered table-striped table-condensed">
  165. <thead>
  166. <tr>
  167. <th>Type</th>
  168. <th>Description</th>
  169. </tr>
  170. </thead>
  171. <tbody>
  172. <tr>
  173. <td><a class="xref" href="Grpc.Core.CallCredentials.html">CallCredentials</a></td>
  174. <td></td>
  175. </tr>
  176. </tbody>
  177. </table>
  178. <a id="Grpc_Core_CallCredentials_InternalPopulateConfiguration_" data-uid="Grpc.Core.CallCredentials.InternalPopulateConfiguration*"></a>
  179. <h4 id="Grpc_Core_CallCredentials_InternalPopulateConfiguration_Grpc_Core_CallCredentialsConfiguratorBase_System_Object_" data-uid="Grpc.Core.CallCredentials.InternalPopulateConfiguration(Grpc.Core.CallCredentialsConfiguratorBase,System.Object)">InternalPopulateConfiguration(CallCredentialsConfiguratorBase, Object)</h4>
  180. <div class="markdown level1 summary"><p>Populates call credentials configurator with this instance&apos;s configuration.
  181. End users never need to invoke this method as it is part of internal implementation.</p>
  182. </div>
  183. <div class="markdown level1 conceptual"></div>
  184. <h5 class="decalaration">Declaration</h5>
  185. <div class="codewrapper">
  186. <pre><code class="lang-csharp hljs">public abstract void InternalPopulateConfiguration(CallCredentialsConfiguratorBase configurator, object state)</code></pre>
  187. </div>
  188. <h5 class="parameters">Parameters</h5>
  189. <table class="table table-bordered table-striped table-condensed">
  190. <thead>
  191. <tr>
  192. <th>Type</th>
  193. <th>Name</th>
  194. <th>Description</th>
  195. </tr>
  196. </thead>
  197. <tbody>
  198. <tr>
  199. <td><a class="xref" href="Grpc.Core.CallCredentialsConfiguratorBase.html">CallCredentialsConfiguratorBase</a></td>
  200. <td><span class="parametername">configurator</span></td>
  201. <td></td>
  202. </tr>
  203. <tr>
  204. <td><span class="xref">System.Object</span></td>
  205. <td><span class="parametername">state</span></td>
  206. <td></td>
  207. </tr>
  208. </tbody>
  209. </table>
  210. </article>
  211. </div>
  212. <div class="hidden-sm col-md-2" role="complementary">
  213. <div class="sideaffix">
  214. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  215. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  216. </nav>
  217. </div>
  218. </div>
  219. </div>
  220. </div>
  221. <footer>
  222. <div class="grad-bottom"></div>
  223. <div class="footer">
  224. <div class="container">
  225. <span class="pull-right">
  226. <a href="#top">Back to top</a>
  227. </span>
  228. <span>Generated by <strong>DocFX</strong></span>
  229. </div>
  230. </div>
  231. </footer>
  232. </div>
  233. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  234. <script type="text/javascript" src="../styles/docfx.js"></script>
  235. <script type="text/javascript" src="../styles/main.js"></script>
  236. </body>
  237. </html>