Namespace: Users

Foursquare ยป Users

Source:
./lib/node-foursquare.js, line 27

Methods

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

Retrieve a list of badges.

Source:
./lib/node-foursquare.js, line 290
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], accessToken, [params], callback)

Retrieve Check-ins for a Foursquare User.

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

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

Retrieve Friends for a Foursquare User.

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

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

Retrieve Tips for a Foursquare User.

Source:
./lib/node-foursquare.js, line 339
See:
  • https://developer.foursquare.com/docs/users/tips.html
Parameters:
Name Type Argument Default Description
userId String <optional>
"self" The id of the user.
accessToken String The access token provided by Foursquare for the current 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.
callback Function The function to call with results, function({Error} error, {Object} results).

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

Retrieve Todos for a Foursquare User.

Source:
./lib/node-foursquare.js, line 357
See:
  • https://developer.foursquare.com/docs/users/todos.html
Parameters:
Name Type Argument Default Description
userId String <optional>
"self" The id of the user.
accessToken String The access token provided by Foursquare for the current 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.
callback Function The function to call with results, function({Error} error, {Object} results).

<static> getUser(userId, accessToken, callback)

Retrieve a Foursquare User.

Source:
./lib/node-foursquare.js, line 247
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([userId], aspect, [field], accessToken, [params], callback)

Source:
./lib/node-foursquare.js, line 265
See:
  • https://developer.foursquare.com/docs/index_docs.html
Parameters:
Name Type Argument Default Description
userId String <optional>
"self" The id of the User to retreive.
aspect String The aspect to retrieve. Refer to Foursquare documentation for details on currently supported aspects.
field String <optional>
aspect 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.
params Object <optional>
An object containing additional parameters. Refer to Foursquare documentation for details on currently supported parameters.
callback Function The function to call with results, function({Error} error, {Object} results).

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

Retrieve Venues visited by a Foursquare User.

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

Find Foursquare Users.

Source:
./lib/node-foursquare.js, line 232
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).