fi.foyt.foursquare.api.entities

Class Checkin

java.lang.Object

fi.foyt.foursquare.api.entities.Checkin

All Implemented Interfaces:

FoursquareEntity, Serializable

public class Checkin
extends Object
implements FoursquareEntity

Class representing Checkin entity

Author:

Antti Leppä

See Also:

https://developer.foursquare.com/docs/responses/checkin.html, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Checkin()

Method Summary

Methods

Modifier and Type	Method and Description
CommentGroup	getComments() Returns comments for checkin
Long	getCreatedAt() Returns when this checkin was created (epoch)
String	getId() Returns checkin id
Boolean	getIsMayor() Returns is the checked user mayor
Location	getLocation() Returns Location of the checkin.
CheckinGroup	getOverlaps() Returns checkins from friends checked into the same venue around the same time.
PhotoGroup	getPhotos() Returns photos of the checkin
String	getShout() Returns shout text
Source	getSource() Returns Source object containing application name and url that created this checkin
String	getTimeZone() Returns timezone of the checkin
String	getType() Returns checkin type (checkin, shout, or venueless)
CompactUser	getUser() Returns user who checked in
CompactVenue	getVenue() Returns venue if any
Boolean	isPrivate() Returns is this a private checkin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Checkin

public Checkin()

Method Detail

getId

public String getId()

Returns checkin id

Returns:

checkin id

getType

public String getType()

Returns checkin type (checkin, shout, or venueless)

Returns:

checkin type

isPrivate

public Boolean isPrivate()

Returns is this a private checkin

Returns:

is this a private checkin

getUser

public CompactUser getUser()

Returns user who checked in

Returns:

user who checked in

getIsMayor

public Boolean getIsMayor()

Returns is the checked user mayor

Returns:

is the checked user mayor

getTimeZone

public String getTimeZone()

Returns timezone of the checkin

Returns:

timezone of the checkin

getVenue

public CompactVenue getVenue()

Returns venue if any

Returns:

venue if any

getLocation

public Location getLocation()

Returns Location of the checkin. Field may be present if the type of this checkin is shout or venueless.

Returns:

Location of the checkin

getShout

public String getShout()

Returns shout text

Returns:

shout text

getCreatedAt

public Long getCreatedAt()

Returns when this checkin was created (epoch)

Returns:

when this checkin was created

getPhotos

public PhotoGroup getPhotos()

Returns photos of the checkin

Returns:

photos of the checkin

getComments

public CommentGroup getComments()

Returns comments for checkin

Returns:

comments for checkin

getSource

public Source getSource()

Returns Source object containing application name and url that created this checkin

Returns:

Checkin source

getOverlaps

public CheckinGroup getOverlaps()

Returns checkins from friends checked into the same venue around the same time.

Returns:

Overlapping checkins