/doc/modules/mod_oauth/m_oauth_app.html

https://code.google.com/p/zotonic/ · HTML · 119 lines · 99 code · 20 blank · 0 comment · 0 complexity · 0dd2a1292ce03487370b28a84507a165 MD5 · raw file 

    

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

  2. <html>
    3. 

  3. <head>
    4. 

  4. <title>Module m_oauth_app</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 m_oauth_app</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; application (server) store.
    13. 

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

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

  15. 

  16. <p><b>Behaviours:</b> <a href="gen_model.html"><tt>gen_model</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; application (server) store.
    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="#authorize_request_token-3">authorize_request_token/3</a></td><td></td></tr>
    22. 

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

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

  24. <tr><td valign="top"><a href="#consumer_tokens-2">consumer_tokens/2</a></td><td></td></tr>
    25. 

  25. <tr><td valign="top"><a href="#create_consumer-5">create_consumer/5</a></td><td></td></tr>
    26. 

  26. <tr><td valign="top"><a href="#delete_consumer-2">delete_consumer/2</a></td><td></td></tr>
    27. 

  27. <tr><td valign="top"><a href="#exchange_request_for_access-2">exchange_request_for_access/2</a></td><td></td></tr>
    28. 

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

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

  30. <tr><td valign="top"><a href="#m_find_value-3">m_find_value/3</a></td><td>Fetch the value for the key from a model source.</td></tr>
    31. 

  31. <tr><td valign="top"><a href="#m_to_list-2">m_to_list/2</a></td><td>Transform a m_config value to a list, used for template loops.</td></tr>
    32. 

  32. <tr><td valign="top"><a href="#m_value-2">m_value/2</a></td><td>Transform a model value so that it can be formatted or piped through filters.</td></tr>
    33. 

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

  34. <tr><td valign="top"><a href="#secrets_for_verify-4">secrets_for_verify/4</a></td><td></td></tr>
    35. 

  35. <tr><td valign="top"><a href="#update_consumer-3">update_consumer/3</a></td><td></td></tr>
    36. 

  36. </table>
    37. 

  37. 

  38. <h2><a name="functions">Function Details</a></h2>
    39. 

  39. 

  40. <h3 class="function"><a name="authorize_request_token-3">authorize_request_token/3</a></h3>
    41. 

  41. <div class="spec">
    42. 

  42. <p><tt>authorize_request_token(Token, UserId, Context) -&gt; any()</tt></p>
    43. 

  43. </div>
    44. 

  44. 

  45. <h3 class="function"><a name="check_nonce-5">check_nonce/5</a></h3>
    46. 

  46. <div class="spec">
    47. 

  47. <p><tt>check_nonce(Consumer, Token, Timestamp, Nonce, Context) -&gt; any()</tt></p>
    48. 

  48. </div>
    49. 

  49. 

  50. <h3 class="function"><a name="consumer_lookup-2">consumer_lookup/2</a></h3>
    51. 

  51. <div class="spec">
    52. 

  52. <p><tt>consumer_lookup(Key, Context) -&gt; any()</tt></p>
    53. 

  53. </div>
    54. 

  54. 

  55. <h3 class="function"><a name="consumer_tokens-2">consumer_tokens/2</a></h3>
    56. 

  56. <div class="spec">
    57. 

  57. <p><tt>consumer_tokens(Id, Context) -&gt; any()</tt></p>
    58. 

  58. </div>
    59. 

  59. 

  60. <h3 class="function"><a name="create_consumer-5">create_consumer/5</a></h3>
    61. 

  61. <div class="spec">
    62. 

  62. <p><tt>create_consumer(Title, URL, Desc, Callback, Context) -&gt; any()</tt></p>
    63. 

  63. </div>
    64. 

  64. 

  65. <h3 class="function"><a name="delete_consumer-2">delete_consumer/2</a></h3>
    66. 

  66. <div class="spec">
    67. 

  67. <p><tt>delete_consumer(Id, Context) -&gt; any()</tt></p>
    68. 

  68. </div>
    69. 

  69. 

  70. <h3 class="function"><a name="exchange_request_for_access-2">exchange_request_for_access/2</a></h3>
    71. 

  71. <div class="spec">
    72. 

  72. <p><tt>exchange_request_for_access(Token, Context) -&gt; any()</tt></p>
    73. 

  73. </div>
    74. 

  74. 

  75. <h3 class="function"><a name="get_consumer-2">get_consumer/2</a></h3>
    76. 

  76. <div class="spec">
    77. 

  77. <p><tt>get_consumer(Id, Context) -&gt; any()</tt></p>
    78. 

  78. </div>
    79. 

  79. 

  80. <h3 class="function"><a name="get_request_token-2">get_request_token/2</a></h3>
    81. 

  81. <div class="spec">
    82. 

  82. <p><tt>get_request_token(Tok, Context) -&gt; any()</tt></p>
    83. 

  83. </div>
    84. 

  84. 

  85. <h3 class="function"><a name="m_find_value-3">m_find_value/3</a></h3>
    86. 

  86. <div class="spec">
    87. 

  87. <p><tt>m_find_value(Id::Key, M::Source, Context) -&gt; term()</tt></p>
    88. 

  88. </div><p>Fetch the value for the key from a model source</p>
    89. 

  89. 

  90. <h3 class="function"><a name="m_to_list-2">m_to_list/2</a></h3>
    91. 

  91. <div class="spec">
    92. 

  92. <p><tt>m_to_list(M::Source, Context) -&gt; list()</tt></p>
    93. 

  93. </div><p>Transform a m_config value to a list, used for template loops</p>
    94. 

  94. 

  95. <h3 class="function"><a name="m_value-2">m_value/2</a></h3>
    96. 

  96. <div class="spec">
    97. 

  97. <p><tt>m_value(M::Source, Context) -&gt; term()</tt></p>
    98. 

  98. </div><p>Transform a model value so that it can be formatted or piped through filters</p>
    99. 

  99. 

  100. <h3 class="function"><a name="request_token-2">request_token/2</a></h3>
    101. 

  101. <div class="spec">
    102. 

  102. <p><tt>request_token(Consumer, Context) -&gt; any()</tt></p>
    103. 

  103. </div>
    104. 

  104. 

  105. <h3 class="function"><a name="secrets_for_verify-4">secrets_for_verify/4</a></h3>
    106. 

  106. <div class="spec">
    107. 

  107. <p><tt>secrets_for_verify(Type, Consumer, Token, Context) -&gt; any()</tt></p>
    108. 

  108. </div>
    109. 

  109. 

  110. <h3 class="function"><a name="update_consumer-3">update_consumer/3</a></h3>
    111. 

  111. <div class="spec">
    112. 

  112. <p><tt>update_consumer(Id, Update, Context) -&gt; any()</tt></p>
    113. 

  113. </div>
    114. 

  114. <hr>
    115. 

  115. 

  116. <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>
    117. 

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

  118. </body>
    119. 

  119. </html>
    120.