Four Square Lists

Gives details about a list.

Figure 1a. Instantiate Lists
$lists = eden('foursquare')->lists($_SESSION['oauth_token']);
Figure 1b. Usage: Retrieve count and items of users following this list.
$lists->getFollowers('[LIST_ID]');
Figure 1c. Usage: Create a New List
$lists
	->setDescription('YOUR LIST DESCRIPTION')	//optional
    ->setCollaborative('[BOOLEAN]')				//optional
    ->setPhotoId('[PHOTO_ID]')					//optional
	->addlist('NAME OF THE LIST');
Figure 1d. Usage: Create a New List
$lists
	->setDescription('YOUR LIST DESCRIPTION')	//optional
    ->setCollaborative('[BOOLEAN]')				//optional
    ->setPhotoId('[PHOTO_ID]')					//optional
	->addlist('NAME OF THE LIST');
Figure 1e. Usage: Follow a List
$lists->followList('LIST_ID');
Figure 1f. Usage: Unfollow a List
$lists->unfollowList('LIST_ID');
Figure 1g. Usage: Share a List
$lists
	->broadcast('facebook')					//optional
    ->setMesage('Yoru Message Text Here')	//optional
	->shareList('LIST_ID');
Figure 1h. Lists Methods
Method Arguments Returns Description
$lists->broadcast($broadcast);
  1. string
Eden_Foursquare_List Where to broadcast this list. Send twitter if you want to send to twitter, facebook if you want to send to facebook, or twitter,facebook if you want to send to both.
$lists->setMessage($message);
  1. string
Eden_Foursquare_List A personal note to include with the share.
$lists->setUrl($url);
  1. string
Eden_Foursquare_List The url of the homepage of the venue.
$lists->setBeforeId($beforeId);
  1. string
Eden_Foursquare_List Move itemId before beforeId.
$lists->setAfterId($afterId);
  1. string
Eden_Foursquare_List Move itemId after afterId.
$lists->setText($text);
  1. string
Eden_Foursquare_List If the target is a user-created list, this will create a public tip on the venue. If the target is /userid/todos, the text will be a private note that is only visible to the author.
$lists->setItemId($itemId);
  1. string
Eden_Foursquare_List Used in conjuction with listId, the id of an item on that list that we wish to copy to this list.
$lists->setListId($listId);
  1. string
Eden_Foursquare_List Used in conjuction with itemId, the id for a user created or followed list as well as one of USER_ID/tips, USER_ID/todos, or USER_ID/dones.
$lists->setTipId($tipId);
  1. string
Eden_Foursquare_List Used to add a tip to a list. Cannot be used in conjunction with the text and url fields.
$lists->setVenueId($venueId);
  1. string
Eden_Foursquare_List A venue to add to the list.
$lists->setDescription($description);
  1. string
Eden_Foursquare_List The description of the list.
$lists->setListName($name);
  1. string
Eden_Foursquare_List If present and a non-empty value, updates the List name.
$lists->setCollaborative(); none Eden_Foursquare_List Set to can be edited by friends.
$lists->setPhotoId($photoId);
  1. string
Eden_Foursquare_List The id of a photo that should be set as the list photo.
$lists->addlist($name);
  1. string
  2. - The name of the list.
array Allows users to create a new list.
$lists->getFollowers($listId);
  1. string
  2. - Id for a user-created list
array Returns a count and items of users following this list.
$lists->suggestPhoto($listId, $itemId);
  1. string
  2. - Id for a user-created list
  3. string
  4. - Id of item on this list.
array Suggests photos that may be appropriate for this item.
$lists->suggestTips($listId, $itemId);
  1. string
  2. - Id for a user-created list
  3. string
  4. - Id of item on this list.
array Suggests tips that may be appropriate for this item.
$lists->suggestVenues($listId);
  1. string
  2. - Id for a user-created list
array Suggests venues may be appropriate for this item.
$lists->addItem($listId);
  1. string
  2. - Id for a user-created list
array Allows you to add an item to a list. All fields are optional, but exactly one of the following must be specified: venueId, tipId, listId and itemId
$lists->updateItem($listId, $itemId);
  1. string
  2. - Id for a user-created list
  3. string
  4. - The id of an item on this list.
array Allows you to update items on user-created lists.
$lists->deleteItem($listId, $itemId);
  1. string
  2. - Id for a user-created list or followed list or one of USER_ID/tips, USER_ID/todos, or USER_ID/dones.
  3. string
  4. - Id of the item to delete.
array Allows you to delete an item from a list.
$lists->moveItem($listId, $itemId);
  1. string
  2. - Id for a user-created list
  3. string
  4. - Id of the item to delete.
array Allows you to move an item on a list. One of beforeId or afterId must be specified.
$lists->followList($listId);
  1. string
  2. - Id for a user-created list
array Allows you to follow a list.
$lists->unfollowList($listId);
  1. string
  2. - Id for a user-created list
array Allows you to unfollow a list.
$lists->shareList($listId);
  1. string
  2. - Id for a user-created list
array Share a user-created list to twitter or facebook.

© 2012 Openovate Labs. All rights reserved.