Module: node-foursquare/Users

node-foursquare/Users

A module for retrieving information about Users from Foursquare.

Source:
../node-foursquare/lib/users.js, line 1

Methods

<static> getBadges([userId], [field], accessToken, callback)

Retrieve a list of badges.

Source:
../node-foursquare/lib/users.js, line 108
See:
  • https://developer.foursquare.com/docs/users/badges.html
Parameters:
Name Type Argument Default Description
userId String <optional>
"self" The id of the user.
field String <optional>
"badges" The field to return from the JSON response. Refer to the documentation for the specific aspect for details.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getCheckins([userId], [params], accessToken, callback)

Retrieve Check-ins for a Foursquare User.

Source:
../node-foursquare/lib/users.js, line 125
See:
  • https://developer.foursquare.com/docs/users/checkins.html
Parameters:
Name Type Argument Default Description
userId String <optional>
"self" The id of the user.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getFriends([userId], [params], accessToken, callback)

Retrieve Friends for a Foursquare User.

Source:
../node-foursquare/lib/users.js, line 140
See:
  • https://developer.foursquare.com/docs/users/friends.html
Parameters:
Name Type Argument Default Description
userId String <optional>
"self" The id of the user.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getLeaderboard([params], accessToken, callback)

Returns the leaderboard for the User identified by the supplied accessToken.

Source:
../node-foursquare/lib/users.js, line 19
See:
  • https://developer.foursquare.com/docs/users/leaderboard.html
Parameters:
Name Type Argument Description
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getRequests(accessToken, callback)

Retrieve Friend Requests for the user identified by the supplied accessToken.

Source:
../node-foursquare/lib/users.js, line 46
See:
  • https://developer.foursquare.com/docs/users/requests.html
Parameters:
Name Type Description
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getTips([userId], [params], accessToken, callback)

Retrieve Tips for a Foursquare User.

Source:
../node-foursquare/lib/users.js, line 157
See:
  • https://developer.foursquare.com/docs/users/tips.html
Parameters:
Name Type Argument Default Description
userId String <optional>
"self" The id of the user.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
Properties
Name Type Argument Description
lat String | Number <optional>
The latitude of the location around which to search.
lng String | Number <optional>
The longitude of the location around which to search.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getTodos([userId], [params], accessToken, callback)

Retrieve Todos for a Foursquare User.

Source:
../node-foursquare/lib/users.js, line 174
See:
  • https://developer.foursquare.com/docs/users/todos.html
Parameters:
Name Type Argument Default Description
userId String <optional>
"self" The id of the user.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
Properties
Name Type Argument Description
lat String | Number <optional>
The latitude of the location around which to search.
lng String | Number <optional>
The longitude of the location around which to search.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getUser(userId, accessToken, callback)

Retrieve a Foursquare User.

Source:
../node-foursquare/lib/users.js, line 59
See:
  • https://developer.foursquare.com/docs/users/users.html
Parameters:
Name Type Description
userId String The id of the User to retreive.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getUserAspect(aspect, [userId], [field], [params], accessToken, callback)

Retreive a named aspect for a User from the Foursquare API.

Source:
../node-foursquare/lib/users.js, line 85
See:
  • https://developer.foursquare.com/docs/index_docs.html
Parameters:
Name Type Argument Default Description
aspect String The aspect to retrieve. Refer to Foursquare documentation for details on currently supported aspects.
userId String <optional>
"self" The id of the User to retreive.
field String <optional>
aspect The field to return from the JSON response. Refer to the documentation for the specific aspect for details.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getVenueHistory([userId], [params], accessToken, callback)

Retrieve Venues visited by a Foursquare User.

Source:
../node-foursquare/lib/users.js, line 191
See:
  • https://developer.foursquare.com/docs/users/venuehistory.html
Parameters:
Name Type Argument Default Description
userId String <optional>
"self" The id of the user.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).

Find Foursquare Users.

Source:
../node-foursquare/lib/users.js, line 33
See:
  • https://developer.foursquare.com/docs/users/search.html
Parameters:
Name Type Argument Description
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
accessToken String The access token provided by Foursquare for the current user.
callback Function The function to call with results, function({Error} error, {Object} results).