/docs/reference.htm

# · HTML · 152 lines · 152 code · 0 blank · 0 comment · 0 complexity · e34ecc13b009ac3a0129339b126a087d MD5 · raw file 

    

  1. <!DOCTYPE html>

    2. 

  2. <html>

    3. 

  3. <head>

    4. 

  4.     <title>Foursquare Helper for WebMatrix - Reference</title>

    5. 

  5.     <link href="content/Site.css" rel="stylesheet" type="text/css" />

    6. 

  6.     <meta http-equiv="Content-type" content="text/html;charset=UTF-8" />

    7. 

  7. </head>

    8. 

  8. <body>

    9. 

  9.     <div class="container">

    10. 

  10.         <div class="header">

    11. 

  11.             <img src="content/images/webx-icon.png" alt="WebMatrix" />

    12. 

  12.             <img src="content/images/foursquare-logo.png" alt="Foursquare Logo" class="partnerLogo" />

    13. 

  13.             <h1>

    14. 

  14.                 Microsoft WebMatrix Helpers</h1>

    15. 

  15.             <h2>

    16. 

  16.                 Foursquare Helper - Reference</h2>

    17. 

  17.         </div>

    18. 

  18.         <div class="content">

    19. 

  19.             <div class="navLinks">

    20. 

  20.                 <a href="startHere.htm">Start Here</a> | <a href="reference.htm">Helper Reference</a>

    21. 

  21.             </div>

    22. 

  22.             <h3>

    23. 

  23.                 Helper Methods</h3>

    24. 

  24. 			<p><em>Note: Current version does not support the full Foursquare API.</em></p>

    25. 

  25.             <table class="memberdecls">

    26. 

  26.                 <tr>

    27. 

  27.                     <td class="memItemLeft">

    28. 

  28.                         static void

    29. 

  29.                     </td>

    30. 

  30.                     <td class="memItemRight">

    31. 

  31.                         <strong>Initialize</strong> (string consumerKey, string consumerSecret, [string callbackUrl])

    32. 

  32.                     </td>

    33. 

  33.                 </tr>

    34. 

  34.                 <tr>

    35. 

  35.                     <td class="mdescLeft">

    36. 

  36.                         &nbsp;

    37. 

  37.                     </td>

    38. 

  38.                     <td class="mdescRight">

    39. 

  39.                         Initializes the Foursquare helper with the consumer key and secret values. 

    40. 

  40.                     </td>

    41. 

  41.                 </tr>

    42. 

  42.                 <tr>

    43. 

  43.                     <td class="memItemLeft">

    44. 

  44.                         static string

    45. 

  45.                     </td>

    46. 

  46.                     <td class="memItemRight">

    47. 

  47.                         <strong>GetAuthorizationLink</strong> ([string returnUrl])

    48. 

  48.                     </td>

    49. 

  49.                 </tr>

    50. 

  50.                 <tr>

    51. 

  51.                     <td class="mdescLeft">

    52. 

  52.                         &nbsp;

    53. 

  53.                     </td>

    54. 

  54.                     <td class="mdescRight">

    55. 

  55.                         Retrieves the Foursquare login Url, for your users to login to Foursquare throught

    56. 

  56.                         your site.

    57. 

  57.                     </td>

    58. 

  58.                 </tr>

    59. 

  59.                  <tr>

    60. 

  60.                     <td class="memItemLeft">

    61. 

  61.                         static string

    62. 

  62.                     </td>

    63. 

  63.                     <td class="memItemRight">

    64. 

  64.                         <strong>GetAccessToken</strong> ()

    65. 

  65.                     </td>

    66. 

  66.                 </tr>

    67. 

  67.                 <tr>

    68. 

  68.                     <td class="mdescLeft">

    69. 

  69.                         &nbsp;

    70. 

  70.                     </td>

    71. 

  71.                     <td class="mdescRight">

    72. 

  72.                         Once the user has granted access into Foursquare, this method returns the user's AccessToken for calling the helper methods that require it.

    73. 

  73.                     </td>

    74. 

  74.                 </tr>

    75. 

  75.                 <tr>

    76. 

  76.                     <td class="memItemLeft">

    77. 

  77.                         static IList&lt;<a href="http://developer.foursquare.com/docs/responses/user.html">User</a>&gt;

    78. 

  78.                     </td>

    79. 

  79.                     <td class="memItemRight">

    80. 

  80.                         <b>GetFriends</b> (string accessToken, [int userId])

    81. 

  81.                     </td>

    82. 

  82.                 </tr>

    83. 

  83.                 <tr>

    84. 

  84.                     <td class="mdescLeft">

    85. 

  85.                         &nbsp;

    86. 

  86.                     </td>

    87. 

  87.                     <td class="mdescRight">

    88. 

  88.                         Returns the list of friends for a given user. If the userId is not specified,

    89. 

  89.                         returns the friends of the logged in user.

    90. 

  90.                     </td>

    91. 

  91.                 </tr>

    92. 

  92.                 <tr>

    93. 

  93.                     <td class="memItemLeft">

    94. 

  94.                         static <a href="http://developer.foursquare.com/docs/responses/user.html">User</a>

    95. 

  95.                     </td>

    96. 

  96.                     <td class="memItemRight">

    97. 

  97.                         <strong>GetUser</strong> (string accessToken, [int userId])

    98. 

  98.                     </td>

    99. 

  99.                 </tr>

    100. 

  100.                 <tr>

    101. 

  101.                     <td class="mdescLeft">

    102. 

  102.                         &nbsp;

    103. 

  103.                     </td>

    104. 

  104.                     <td class="mdescRight">

    105. 

  105.                         Returns profile information (badges, etc.) for a given user. If the userId is not specified, returns the logged in user information.

    106. 

  106.                     </td>

    107. 

  107.                 </tr>

    108. 

  108.                 <tr>

    109. 

  109.                     <td class="memItemLeft">

    110. 

  110.                         @helper

    111. 

  111.                     </td>

    112. 

  112.                     <td class="memItemRight">

    113. 

  113.                         <strong>GetFoursquareButton</strong> ([string venueId], [string tipId], [string

    114. 

  114.                         color])

    115. 

  115.                     </td>

    116. 

  116.                 </tr>

    117. 

  117.                 <tr>

    118. 

  118.                     <td class="mdescLeft">

    119. 

  119.                         &nbsp;

    120. 

  120.                     </td>

    121. 

  121.                     <td class="mdescRight">

    122. 

  122.                         Shows a Foursquare Button, to add a venue or a tip to the user's TODO list. You should either specify the venueId or the tipId.

    123. 

  123.                         Calling the Initialize() method is not required if you only want to use this method.

    124. 

  124.                     </td>

    125. 

  125.                 </tr>

    126. 

  126.                 <tr>

    127. 

  127.                     <td class="memItemLeft">

    128. 

  128.                         @helper

    129. 

  129.                     </td>

    130. 

  130.                     <td class="memItemRight">

    131. 

  131.                         <strong>GetBadgesWidget</strong> (string accessToken, [int userId])

    132. 

  132.                     </td>

    133. 

  133.                 </tr>

    134. 

  134.                  <tr>

    135. 

  135.                     <td class="mdescLeft">

    136. 

  136.                         &nbsp;

    137. 

  137.                     </td>

    138. 

  138.                     <td class="mdescRight">

    139. 

  139.                         Shows a widget listing the user's Foursquare badges. If the userId is not specified, defaults to the logged in user.

    140. 

  140.                     </td>

    141. 

  141.                 </tr>

    142. 

  142.                 <tr><td class="memItemLeft"></td><td class="memItemRight"></td></tr>                              

    143. 

  143.             </table>         

    144. 

  144.         </div>

    145. 

  145.         <ul class="footer">

    146. 

  146.             <li>We're always looking for <a href="mailto:webapp@microsoft.com">bugs, feedback and

    147. 

  147.                 suggestions!</a></li>

    148. 

  148.             <li>&copy; 2010-2011 Microsoft Corporation. Powered by IIS Express.</li>

    149. 

  149.         </ul>

    150. 

  150.     </div>

    151. 

  151. </body>

    152. 

  152. </html>
    153.