protocol_g_r_p_c_authorization_protocol-p.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC Objective-C: &lt;GRPCAuthorizationProtocol&gt; Protocol Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC Objective-C
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. </div><!-- top -->
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#pub-methods">Instance Methods</a> </div>
  65. <div class="headertitle">
  66. <div class="title">&lt;GRPCAuthorizationProtocol&gt; Protocol Reference</div> </div>
  67. </div><!--header-->
  68. <div class="contents">
  69. <p>Implement this protocol to provide a token to gRPC when a call is initiated.
  70. <a href="protocol_g_r_p_c_authorization_protocol-p.html#details">More...</a></p>
  71. <p><code>#import &lt;<a class="el" href="_g_r_p_c_types_8h_source.html">GRPCTypes.h</a>&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  74. Instance Methods</h2></td></tr>
  75. <tr class="memitem:af3cebbb00be8ff9792e42cd73500d2c3"><td class="memItemLeft" align="right" valign="top">(void)&#160;</td><td class="memItemRight" valign="bottom">- <a class="el" href="protocol_g_r_p_c_authorization_protocol-p.html#af3cebbb00be8ff9792e42cd73500d2c3">getTokenWithHandler:</a></td></tr>
  76. <tr class="memdesc:af3cebbb00be8ff9792e42cd73500d2c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called when gRPC is about to start the call. <a href="protocol_g_r_p_c_authorization_protocol-p.html#af3cebbb00be8ff9792e42cd73500d2c3">More...</a><br /></td></tr>
  77. <tr class="separator:af3cebbb00be8ff9792e42cd73500d2c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. </table>
  79. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  80. <div class="textblock"><p>Implement this protocol to provide a token to gRPC when a call is initiated. </p>
  81. </div><h2 class="groupheader">Method Documentation</h2>
  82. <a id="af3cebbb00be8ff9792e42cd73500d2c3"></a>
  83. <h2 class="memtitle"><span class="permalink"><a href="#af3cebbb00be8ff9792e42cd73500d2c3">&#9670;&nbsp;</a></span>getTokenWithHandler:</h2>
  84. <div class="memitem">
  85. <div class="memproto">
  86. <table class="memname">
  87. <tr>
  88. <td class="memname">- (void) getTokenWithHandler: </td>
  89. <td></td>
  90. <td class="paramtype">(void(^)(NSString *_Nullable token))&#160;</td>
  91. <td class="paramname"><em>handler</em></td>
  92. <td></td>
  93. </tr>
  94. </table>
  95. </div><div class="memdoc">
  96. <p>This method is called when gRPC is about to start the call. </p>
  97. <p>When OAuth token is acquired, <em>handler</em> is expected to be called with <em>token</em> being the new token to be used for this call. </p>
  98. </div>
  99. </div>
  100. <hr/>The documentation for this protocol was generated from the following file:<ul>
  101. <li>src/objective-c/GRPCClient/<a class="el" href="_g_r_p_c_types_8h_source.html">GRPCTypes.h</a></li>
  102. </ul>
  103. </div><!-- contents -->
  104. <!-- start footer part -->
  105. <hr class="footer"/><address class="footer"><small>
  106. Generated on Wed Mar 3 2021 19:20:10 for GRPC Objective-C by &#160;<a href="http://www.doxygen.org/index.html">
  107. <img class="footer" src="doxygen.png" alt="doxygen"/>
  108. </a> 1.8.17
  109. </small></address>
  110. </body>
  111. </html>