Grpc.Core.AuthProperty.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  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 AuthProperty
  8. | gRPC for .NET </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class AuthProperty
  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.AuthProperty">
  73. <h1 id="Grpc_Core_AuthProperty" data-uid="Grpc.Core.AuthProperty" class="text-break">Class AuthProperty
  74. </h1>
  75. <div class="markdown level0 summary"><p>A property of an <a class="xref" href="Grpc.Core.AuthContext.html">AuthContext</a>.
  76. Note: experimental API that can change or be removed without any prior notice.</p>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><span class="xref">AuthProperty</span></div>
  83. </div>
  84. <h6><strong>Namespace</strong>: <a class="xref" href="Grpc.Core.html">Grpc.Core</a></h6>
  85. <h6><strong>Assembly</strong>: Grpc.Core.Api.dll</h6>
  86. <h5 id="Grpc_Core_AuthProperty_syntax">Syntax</h5>
  87. <div class="codewrapper">
  88. <pre><code class="lang-csharp hljs">public class AuthProperty : object</code></pre>
  89. </div>
  90. <h3 id="properties">Properties
  91. </h3>
  92. <a id="Grpc_Core_AuthProperty_Name_" data-uid="Grpc.Core.AuthProperty.Name*"></a>
  93. <h4 id="Grpc_Core_AuthProperty_Name" data-uid="Grpc.Core.AuthProperty.Name">Name</h4>
  94. <div class="markdown level1 summary"><p>Gets the name of the property.</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 string Name { get; }</code></pre>
  100. </div>
  101. <h5 class="propertyValue">Property Value</h5>
  102. <table class="table table-bordered table-striped table-condensed">
  103. <thead>
  104. <tr>
  105. <th>Type</th>
  106. <th>Description</th>
  107. </tr>
  108. </thead>
  109. <tbody>
  110. <tr>
  111. <td><span class="xref">System.String</span></td>
  112. <td></td>
  113. </tr>
  114. </tbody>
  115. </table>
  116. <a id="Grpc_Core_AuthProperty_Value_" data-uid="Grpc.Core.AuthProperty.Value*"></a>
  117. <h4 id="Grpc_Core_AuthProperty_Value" data-uid="Grpc.Core.AuthProperty.Value">Value</h4>
  118. <div class="markdown level1 summary"><p>Gets the string value of the property.</p>
  119. </div>
  120. <div class="markdown level1 conceptual"></div>
  121. <h5 class="decalaration">Declaration</h5>
  122. <div class="codewrapper">
  123. <pre><code class="lang-csharp hljs">public string Value { get; }</code></pre>
  124. </div>
  125. <h5 class="propertyValue">Property Value</h5>
  126. <table class="table table-bordered table-striped table-condensed">
  127. <thead>
  128. <tr>
  129. <th>Type</th>
  130. <th>Description</th>
  131. </tr>
  132. </thead>
  133. <tbody>
  134. <tr>
  135. <td><span class="xref">System.String</span></td>
  136. <td></td>
  137. </tr>
  138. </tbody>
  139. </table>
  140. <a id="Grpc_Core_AuthProperty_ValueBytes_" data-uid="Grpc.Core.AuthProperty.ValueBytes*"></a>
  141. <h4 id="Grpc_Core_AuthProperty_ValueBytes" data-uid="Grpc.Core.AuthProperty.ValueBytes">ValueBytes</h4>
  142. <div class="markdown level1 summary"><p>Gets the binary value of the property.</p>
  143. </div>
  144. <div class="markdown level1 conceptual"></div>
  145. <h5 class="decalaration">Declaration</h5>
  146. <div class="codewrapper">
  147. <pre><code class="lang-csharp hljs">public byte[] ValueBytes { get; }</code></pre>
  148. </div>
  149. <h5 class="propertyValue">Property Value</h5>
  150. <table class="table table-bordered table-striped table-condensed">
  151. <thead>
  152. <tr>
  153. <th>Type</th>
  154. <th>Description</th>
  155. </tr>
  156. </thead>
  157. <tbody>
  158. <tr>
  159. <td><span class="xref">System.Byte</span>[]</td>
  160. <td></td>
  161. </tr>
  162. </tbody>
  163. </table>
  164. <h3 id="methods">Methods
  165. </h3>
  166. <a id="Grpc_Core_AuthProperty_Create_" data-uid="Grpc.Core.AuthProperty.Create*"></a>
  167. <h4 id="Grpc_Core_AuthProperty_Create_System_String_System_Byte___" data-uid="Grpc.Core.AuthProperty.Create(System.String,System.Byte[])">Create(String, Byte[])</h4>
  168. <div class="markdown level1 summary"><p>Creates an instance of <code>AuthProperty</code>.</p>
  169. </div>
  170. <div class="markdown level1 conceptual"></div>
  171. <h5 class="decalaration">Declaration</h5>
  172. <div class="codewrapper">
  173. <pre><code class="lang-csharp hljs">public static AuthProperty Create(string name, byte[] valueBytes)</code></pre>
  174. </div>
  175. <h5 class="parameters">Parameters</h5>
  176. <table class="table table-bordered table-striped table-condensed">
  177. <thead>
  178. <tr>
  179. <th>Type</th>
  180. <th>Name</th>
  181. <th>Description</th>
  182. </tr>
  183. </thead>
  184. <tbody>
  185. <tr>
  186. <td><span class="xref">System.String</span></td>
  187. <td><span class="parametername">name</span></td>
  188. <td><p>the name</p>
  189. </td>
  190. </tr>
  191. <tr>
  192. <td><span class="xref">System.Byte</span>[]</td>
  193. <td><span class="parametername">valueBytes</span></td>
  194. <td><p>the binary value of the property</p>
  195. </td>
  196. </tr>
  197. </tbody>
  198. </table>
  199. <h5 class="returns">Returns</h5>
  200. <table class="table table-bordered table-striped table-condensed">
  201. <thead>
  202. <tr>
  203. <th>Type</th>
  204. <th>Description</th>
  205. </tr>
  206. </thead>
  207. <tbody>
  208. <tr>
  209. <td><a class="xref" href="Grpc.Core.AuthProperty.html">AuthProperty</a></td>
  210. <td></td>
  211. </tr>
  212. </tbody>
  213. </table>
  214. </article>
  215. </div>
  216. <div class="hidden-sm col-md-2" role="complementary">
  217. <div class="sideaffix">
  218. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  219. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  220. </nav>
  221. </div>
  222. </div>
  223. </div>
  224. </div>
  225. <footer>
  226. <div class="grad-bottom"></div>
  227. <div class="footer">
  228. <div class="container">
  229. <span class="pull-right">
  230. <a href="#top">Back to top</a>
  231. </span>
  232. <span>Generated by <strong>DocFX</strong></span>
  233. </div>
  234. </div>
  235. </footer>
  236. </div>
  237. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  238. <script type="text/javascript" src="../styles/docfx.js"></script>
  239. <script type="text/javascript" src="../styles/main.js"></script>
  240. </body>
  241. </html>