/doc/modules/mod_oauth/mod_oauth.html

https://code.google.com/p/zotonic/ · HTML · 129 lines · 108 code · 21 blank · 0 comment · 0 complexity · b74103658ad4f0fa0111eb4b6ce4c53b MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>Module mod_oauth</title>
    5. 

  5. <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
    6. 

  6. </head>
    7. 

  7. <body bgcolor="white">
    8. 

  8. <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
    9. 

  9. <hr>
    10. 

  10. 

  11. <h1>Module mod_oauth</h1>
    12. 

  12. <ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>OAuth.
    13. 

  13. <p>Copyright Š 2009 Arjan Scherpenisse
    14. 

  14.   Date: 2009-10-02</p>
    15. 

  15. 

  16. <p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p>
    17. 

  17. <p><b>Authors:</b> Arjan Scherpenisse (<a href="mailto:arjan@scherpenisse.net"><tt>arjan@scherpenisse.net</tt></a>).</p>
    18. 

  18. 

  19. <h2><a name="description">Description</a></h2>OAuth.
    20. 

  20. <h2><a name="index">Function Index</a></h2>
    21. 

  21. <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#authenticate-3">authenticate/3</a></td><td></td></tr>
    22. 

  22. <tr><td valign="top"><a href="#check_request_logon-2">check_request_logon/2</a></td><td></td></tr>
    23. 

  23. <tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td>Convert process state when code is changed.</td></tr>
    24. 

  24. <tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td>Trap unknown calls.</td></tr>
    25. 

  25. <tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td>Trap unknown casts.</td></tr>
    26. 

  26. <tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td>Handling all non call/cast messages.</td></tr>
    27. 

  27. <tr><td valign="top"><a href="#init-1">init/1</a></td><td>Initiates the server.</td></tr>
    28. 

  28. <tr><td valign="top"><a href="#is_allowed-3">is_allowed/3</a></td><td></td></tr>
    29. 

  29. <tr><td valign="top"><a href="#oauth_param-2">oauth_param/2</a></td><td></td></tr>
    30. 

  30. <tr><td valign="top"><a href="#request_is_signed-1">request_is_signed/1</a></td><td></td></tr>
    31. 

  31. <tr><td valign="top"><a href="#serve_oauth-3">serve_oauth/3</a></td><td></td></tr>
    32. 

  32. <tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td>Starts the server.</td></tr>
    33. 

  33. <tr><td valign="top"><a href="#str_value-2">str_value/2</a></td><td></td></tr>
    34. 

  34. <tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td>This function is called by a gen_server when it is about to
    35. 

  35.   terminate.</td></tr>
    36. 

  36. <tr><td valign="top"><a href="#test-0">test/0</a></td><td></td></tr>
    37. 

  37. <tr><td valign="top"><a href="#to_oauth_consumer-2">to_oauth_consumer/2</a></td><td></td></tr>
    38. 

  38. </table>
    39. 

  39. 

  40. <h2><a name="functions">Function Details</a></h2>
    41. 

  41. 

  42. <h3 class="function"><a name="authenticate-3">authenticate/3</a></h3>
    43. 

  43. <div class="spec">
    44. 

  44. <p><tt>authenticate(Reason, ReqData, Context) -&gt; any()</tt></p>
    45. 

  45. </div>
    46. 

  46. 

  47. <h3 class="function"><a name="check_request_logon-2">check_request_logon/2</a></h3>
    48. 

  48. <div class="spec">
    49. 

  49. <p><tt>check_request_logon(ReqData, Context) -&gt; any()</tt></p>
    50. 

  50. </div>
    51. 

  51. 

  52. <h3 class="function"><a name="code_change-3">code_change/3</a></h3>
    53. 

  53. <div class="spec">
    54. 

  54. <p><tt>code_change(OldVsn, State, Extra) -&gt; {ok, NewState}</tt></p>
    55. 

  55. </div><p>Convert process state when code is changed</p>
    56. 

  56. 

  57. <h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
    58. 

  58. <div class="spec">
    59. 

  59. <p><tt>handle_call(Message::Request, From, State) -&gt; {reply, Reply, State} | {reply, Reply, State, Timeout} | {noreply, State} | {noreply, State, Timeout} | {stop, Reason, Reply, State} | {stop, Reason, State}</tt></p>
    60. 

  60. </div><p>Trap unknown calls</p>
    61. 

  61. 

  62. <h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
    63. 

  63. <div class="spec">
    64. 

  64. <p><tt>handle_cast(Message::Msg, State) -&gt; {noreply, State} | {noreply, State, Timeout} | {stop, Reason, State}</tt></p>
    65. 

  65. </div><p>Trap unknown casts</p>
    66. 

  66. 

  67. <h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
    68. 

  68. <div class="spec">
    69. 

  69. <p><tt>handle_info(Info, State) -&gt; {noreply, State} | {noreply, State, Timeout} | {stop, Reason, State}</tt></p>
    70. 

  70. </div><p>Handling all non call/cast messages</p>
    71. 

  71. 

  72. <h3 class="function"><a name="init-1">init/1</a></h3>
    73. 

  73. <div class="spec">
    74. 

  74. <p><tt>init(Args) -&gt; {ok, State} | {ok, State, Timeout} | ignore | {stop, Reason}</tt></p>
    75. 

  75. </div><p>Initiates the server.</p>
    76. 

  76. 

  77. <h3 class="function"><a name="is_allowed-3">is_allowed/3</a></h3>
    78. 

  78. <div class="spec">
    79. 

  79. <p><tt>is_allowed(Id, Service, Context) -&gt; any()</tt></p>
    80. 

  80. </div>
    81. 

  81. 

  82. <h3 class="function"><a name="oauth_param-2">oauth_param/2</a></h3>
    83. 

  83. <div class="spec">
    84. 

  84. <p><tt>oauth_param(Param, ReqData) -&gt; any()</tt></p>
    85. 

  85. </div>
    86. 

  86. 

  87. <h3 class="function"><a name="request_is_signed-1">request_is_signed/1</a></h3>
    88. 

  88. <div class="spec">
    89. 

  89. <p><tt>request_is_signed(ReqData) -&gt; any()</tt></p>
    90. 

  90. </div>
    91. 

  91. 

  92. <h3 class="function"><a name="serve_oauth-3">serve_oauth/3</a></h3>
    93. 

  93. <div class="spec">
    94. 

  94. <p><tt>serve_oauth(ReqData, Context, Fun) -&gt; any()</tt></p>
    95. 

  95. </div>
    96. 

  96. 

  97. <h3 class="function"><a name="start_link-1">start_link/1</a></h3>
    98. 

  98. <div class="spec">
    99. 

  99. <p><tt>start_link(Args) -&gt; {ok, Pid} | ignore | {error, Error}</tt></p>
    100. 

  100. </div><p>Starts the server</p>
    101. 

  101. 

  102. <h3 class="function"><a name="str_value-2">str_value/2</a></h3>
    103. 

  103. <div class="spec">
    104. 

  104. <p><tt>str_value(Key, From) -&gt; any()</tt></p>
    105. 

  105. </div>
    106. 

  106. 

  107. <h3 class="function"><a name="terminate-2">terminate/2</a></h3>
    108. 

  108. <div class="spec">
    109. 

  109. <p><tt>terminate(Reason, State) -&gt; <a href="#type-void">void()</a></tt></p>
    110. 

  110. </div><p>This function is called by a gen_server when it is about to
    111. 

  111.   terminate. It should be the opposite of Module:init/1 and do any necessary
    112. 

  112.   cleaning up. When it returns, the gen_server terminates with Reason.
    113. 

  113.   The return value is ignored.</p>
    114. 

  114. 

  115. <h3 class="function"><a name="test-0">test/0</a></h3>
    116. 

  116. <div class="spec">
    117. 

  117. <p><tt>test() -&gt; any()</tt></p>
    118. 

  118. </div>
    119. 

  119. 

  120. <h3 class="function"><a name="to_oauth_consumer-2">to_oauth_consumer/2</a></h3>
    121. 

  121. <div class="spec">
    122. 

  122. <p><tt>to_oauth_consumer(Consumer, X2) -&gt; any()</tt></p>
    123. 

  123. </div>
    124. 

  124. <hr>
    125. 

  125. 

  126. <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
    127. 

  127. <p><i>Generated by EDoc, Aug 12 2011, 19:36:12.</i></p>
    128. 

  128. </body>
    129. 

  129. </html>
    130.