1\name{status-class}
2\Rdversion{1.1}
3\docType{class}
4\alias{status-class}
5\alias{statusFactory}
6\alias{status}
7\alias{buildStatus}
8\alias{show,status-method}
9\alias{as.data.frame,status-method}
10\alias{text,status-method}
11\alias{favorited,status-method}
12\alias{favorited}
13\alias{replyToSN,status-method}
14\alias{replyToSN}
15\alias{created,status-method}
16\alias{truncated,status-method}
17\alias{truncated}
18\alias{replyToSID,status-method}
19\alias{replyToSID}
20\alias{id,status-method}
21\alias{id}
22\alias{replyToUID,status-method}
23\alias{replyToUID}
24\alias{statusSource,status-method}
25\alias{statusSource}
26\alias{screenName,status-method}
27\alias{statusText}
28\alias{statusText,status-method}
29\alias{retweetCount,status-method}
30\alias{retweetCount}
31\alias{retweeted,status-method}
32\alias{retweeted}
33\alias{[[,twitterObjList-method}
34\alias{as.data.frame,twitterObj-method}
35\alias{show,twitterObjList-method}
36\title{Class to contain a Twitter status}
37\description{Container for Twitter status messages, including the text
38  as well as basic information}
39\section{Fields}{
40  \describe{
41    \item{\code{text}:}{The text of the status}
42    \item{\code{screenName}:}{Screen name of the user who posted this status}
43    \item{\code{id}:}{ID of this status}
44    \item{\code{replyToSN}:}{Screen name of the user this is in reply
45      to}
46    \item{\code{replyToUID}:}{ID of the user this was in reply to}
47    \item{\code{statusSource}:}{Source user agent for this tweet}
48    \item{\code{created}:}{When this status was created}
49    \item{\code{truncated}:}{Whether this status was truncated}
50    \item{\code{favorited}:}{Whether this status has been favorited}
51    \item{\code{retweeted}:}{TRUE if this status has been retweeted}
52    \item{\code{retweetCount}:}{The number of times this status has been retweeted}
53  }
54}
55\section{Methods}{
56  \describe{
57     \item{\code{toDataFrame}:}{Converts this into a one row
58       \code{\link{data.frame}}, with each field representing a column.
59       This can also be accomplished by the S4 style
60       \code{as.data.frame(objectName)}.}
61  }
62}
63\details{
64  The \code{status} class is implemented as a reference class.  This class
65  was previously implemented as an S4 class, and for backward
66  compatibility purposes the old S4 accessor methods have been left in,
67  although new code should not be written with these.  An instance of a
68  generator for this class is provided as a convenience to the user as
69  it is configured to handle most standard cases.  To access this
70  generator, use the object \code{statusFactory}.  Accessor set & get
71  methods are provided for every field using reference class
72  \code{$accessors()} methodology (see \code{\link{setRefClass}} for
73  more details).  As an example, the \code{screenName} field could be
74  accessed using \code{object$getScreenName} and
75  \code{object$setScreenName}.
76
77  The constructor of this object assumes that the user is passing in a
78  JSON encoded Twitter status.  It is also possible to directly pass in
79  the arguments.
80
81}
82\author{Jeff Gentry}
83\seealso{
84  \code{\link{userTimeline}}, \code{\link{setRefClass}}
85}
86\examples{
87   \dontrun{
88     st <- statusFactory$new(screenName="test", text="test message")
89     st$getScreenName()
90     st$getText()
91
92     ## Assume 'json' is the return from a Twitter call
93     st <- statusFactory$new(json)
94     st$getScreenName()
95   }
96
97}
98\keyword{classes}
99