3028 lines
107 KiB

8 years ago
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1">
  6. <meta name="theme-color" content="#375EAB">
  7. <title>twitter - The Go Programming Language</title>
  8. <link type="text/css" rel="stylesheet" href="../../../../../lib/godoc/style.css">
  9. <link rel="stylesheet" href="../../../../../lib/godoc/jquery.treeview.css">
  10. <script type="text/javascript">window.initFuncs = [];</script>
  11. </head>
  12. <body>
  13. <div id='lowframe' style="position: fixed; bottom: 0; left: 0; height: 0; width: 100%; border-top: thin solid grey; background-color: white; overflow: auto;">
  14. ...
  15. </div><!-- #lowframe -->
  16. <div id="topbar" class="wide"><div class="container">
  17. <div class="top-heading" id="heading-wide"><a href="http://localhost:6060/">The Go Programming Language</a></div>
  18. <div class="top-heading" id="heading-narrow"><a href="http://localhost:6060/">Go</a></div>
  19. <a href="index.html#" id="menu-button"><span id="menu-button-arrow">&#9661;</span></a>
  20. <form method="GET" action="http://localhost:6060/search">
  21. <div id="menu">
  22. <a href="http://localhost:6060/doc/">Documents</a>
  23. <a href="http://localhost:6060/pkg/">Packages</a>
  24. <a href="http://localhost:6060/project/">The Project</a>
  25. <a href="http://localhost:6060/help/">Help</a>
  26. <a href="http://localhost:6060/blog/">Blog</a>
  27. <input type="text" id="search" name="q" class="inactive" value="Search" placeholder="Search">
  28. </div>
  29. </form>
  30. </div></div>
  31. <div id="page" class="wide">
  32. <div class="container">
  33. <h1>Package twitter</h1>
  34. <div id="nav"></div>
  35. <!--
  36. Copyright 2009 The Go Authors. All rights reserved.
  37. Use of this source code is governed by a BSD-style
  38. license that can be found in the LICENSE file.
  39. -->
  40. <!--
  41. Note: Static (i.e., not template-generated) href and id
  42. attributes start with "pkg-" to make it impossible for
  43. them to conflict with generated attributes (some of which
  44. correspond to Go identifiers).
  45. -->
  46. <script type='text/javascript'>
  47. document.ANALYSIS_DATA = null;
  48. document.CALLGRAPH = null;
  49. </script>
  50. <div id="short-nav">
  51. <dl>
  52. <dd><code>import "github.com/dghubble/go-twitter/twitter"</code></dd>
  53. </dl>
  54. <dl>
  55. <dd><a href="index.html#pkg-overview" class="overviewLink">Overview</a></dd>
  56. <dd><a href="index.html#pkg-index" class="indexLink">Index</a></dd>
  57. </dl>
  58. </div>
  59. <!-- The package's Name is printed as title by the top-level template -->
  60. <div id="pkg-overview" class="toggleVisible">
  61. <div class="collapsed">
  62. <h2 class="toggleButton" title="Click to show Overview section">Overview ▹</h2>
  63. </div>
  64. <div class="expanded">
  65. <h2 class="toggleButton" title="Click to hide Overview section">Overview ▾</h2>
  66. <p>
  67. Package twitter provides a Client for the Twitter API.
  68. </p>
  69. <p>
  70. The twitter package provides a Client for accessing the Twitter API. Here are
  71. some example requests.
  72. </p>
  73. <pre>// Twitter client
  74. client := twitter.NewClient(httpClient)
  75. // Home Timeline
  76. tweets, resp, err := client.Timelines.HomeTimeline(&amp;HomeTimelineParams{})
  77. // Send a Tweet
  78. tweet, resp, err := client.Statuses.Update(&#34;just setting up my twttr&#34;, nil)
  79. // Status Show
  80. tweet, resp, err := client.Statuses.Show(585613041028431872, nil)
  81. // User Show
  82. params := &amp;twitter.UserShowParams{ScreenName: &#34;dghubble&#34;}
  83. user, resp, err := client.Users.Show(params)
  84. // Followers
  85. followers, resp, err := client.Followers.List(&amp;FollowerListParams{})
  86. </pre>
  87. <p>
  88. Required parameters are passed as positional arguments. Optional parameters
  89. are passed in a typed params struct (or pass nil).
  90. </p>
  91. <h3 id="hdr-Authentication">Authentication</h3>
  92. <p>
  93. By design, the Twitter Client accepts any http.Client so user auth (OAuth1) or
  94. application auth (OAuth2) requests can be made by using the appropriate
  95. authenticated client. Use the <a href="https://github.com/dghubble/oauth1">https://github.com/dghubble/oauth1</a> and
  96. <a href="https://github.com/golang/oauth2">https://github.com/golang/oauth2</a> packages to obtain an http.Client which
  97. transparently authorizes requests.
  98. </p>
  99. <p>
  100. For example, make requests as a consumer application on behalf of a user who
  101. has granted access, with OAuth1.
  102. </p>
  103. <pre>// OAuth1
  104. import (
  105. &#34;github.com/dghubble/go-twitter/twitter&#34;
  106. &#34;github.com/dghubble/oauth1&#34;
  107. )
  108. config := oauth1.NewConfig(&#34;consumerKey&#34;, &#34;consumerSecret&#34;)
  109. token := oauth1.NewToken(&#34;accessToken&#34;, &#34;accessSecret&#34;)
  110. // http.Client will automatically authorize Requests
  111. httpClient := config.Client(oauth1.NoContext, token)
  112. // twitter client
  113. client := twitter.NewClient(httpClient)
  114. </pre>
  115. <p>
  116. If no user auth context is needed, make requests as your application with
  117. application auth.
  118. </p>
  119. <pre>// OAuth2
  120. import (
  121. &#34;github.com/dghubble/go-twitter/twitter&#34;
  122. &#34;golang.org/x/oauth2&#34;
  123. )
  124. config := &amp;oauth2.Config{}
  125. token := &amp;oauth2.Token{AccessToken: accessToken}
  126. // http.Client will automatically authorize Requests
  127. httpClient := config.Client(oauth2.NoContext, token)
  128. // twitter client
  129. client := twitter.NewClient(httpClient)
  130. </pre>
  131. <p>
  132. To implement Login with Twitter, see <a href="https://github.com/dghubble/gologin">https://github.com/dghubble/gologin</a>.
  133. </p>
  134. </div>
  135. </div>
  136. <div id="pkg-index" class="toggleVisible">
  137. <div class="collapsed">
  138. <h2 class="toggleButton" title="Click to show Index section">Index ▹</h2>
  139. </div>
  140. <div class="expanded">
  141. <h2 class="toggleButton" title="Click to hide Index section">Index ▾</h2>
  142. <!-- Table of contents for API; must be named manual-nav to turn off auto nav. -->
  143. <div id="manual-nav">
  144. <dl>
  145. <dd><a href="index.html#Bool">func Bool(v bool) *bool</a></dd>
  146. <dd><a href="index.html#Float">func Float(v float64) *float64</a></dd>
  147. <dd><a href="index.html#APIError">type APIError</a></dd>
  148. <dd>&nbsp; &nbsp; <a href="index.html#APIError.Empty">func (e APIError) Empty() bool</a></dd>
  149. <dd>&nbsp; &nbsp; <a href="index.html#APIError.Error">func (e APIError) Error() string</a></dd>
  150. <dd><a href="index.html#AccountService">type AccountService</a></dd>
  151. <dd>&nbsp; &nbsp; <a href="index.html#AccountService.VerifyCredentials">func (s *AccountService) VerifyCredentials(params *AccountVerifyParams) (*User, *http.Response, error)</a></dd>
  152. <dd><a href="index.html#AccountVerifyParams">type AccountVerifyParams</a></dd>
  153. <dd><a href="index.html#BoundingBox">type BoundingBox</a></dd>
  154. <dd><a href="index.html#Client">type Client</a></dd>
  155. <dd>&nbsp; &nbsp; <a href="index.html#NewClient">func NewClient(httpClient *http.Client) *Client</a></dd>
  156. <dd><a href="index.html#Contributor">type Contributor</a></dd>
  157. <dd><a href="index.html#Coordinates">type Coordinates</a></dd>
  158. <dd><a href="index.html#Demux">type Demux</a></dd>
  159. <dd><a href="index.html#DirectMessage">type DirectMessage</a></dd>
  160. <dd><a href="index.html#DirectMessageDestroyParams">type DirectMessageDestroyParams</a></dd>
  161. <dd><a href="index.html#DirectMessageGetParams">type DirectMessageGetParams</a></dd>
  162. <dd><a href="index.html#DirectMessageNewParams">type DirectMessageNewParams</a></dd>
  163. <dd><a href="index.html#DirectMessageSentParams">type DirectMessageSentParams</a></dd>
  164. <dd><a href="index.html#DirectMessageService">type DirectMessageService</a></dd>
  165. <dd>&nbsp; &nbsp; <a href="index.html#DirectMessageService.Destroy">func (s *DirectMessageService) Destroy(id int64, params *DirectMessageDestroyParams) (*DirectMessage, *http.Response, error)</a></dd>
  166. <dd>&nbsp; &nbsp; <a href="index.html#DirectMessageService.Get">func (s *DirectMessageService) Get(params *DirectMessageGetParams) ([]DirectMessage, *http.Response, error)</a></dd>
  167. <dd>&nbsp; &nbsp; <a href="index.html#DirectMessageService.New">func (s *DirectMessageService) New(params *DirectMessageNewParams) (*DirectMessage, *http.Response, error)</a></dd>
  168. <dd>&nbsp; &nbsp; <a href="index.html#DirectMessageService.Sent">func (s *DirectMessageService) Sent(params *DirectMessageSentParams) ([]DirectMessage, *http.Response, error)</a></dd>
  169. <dd>&nbsp; &nbsp; <a href="index.html#DirectMessageService.Show">func (s *DirectMessageService) Show(id int64) (*DirectMessage, *http.Response, error)</a></dd>
  170. <dd><a href="index.html#Entities">type Entities</a></dd>
  171. <dd><a href="index.html#ErrorDetail">type ErrorDetail</a></dd>
  172. <dd><a href="index.html#Event">type Event</a></dd>
  173. <dd><a href="index.html#ExtendedEntity">type ExtendedEntity</a></dd>
  174. <dd><a href="index.html#FollowerIDParams">type FollowerIDParams</a></dd>
  175. <dd><a href="index.html#FollowerIDs">type FollowerIDs</a></dd>
  176. <dd><a href="index.html#FollowerListParams">type FollowerListParams</a></dd>
  177. <dd><a href="index.html#FollowerService">type FollowerService</a></dd>
  178. <dd>&nbsp; &nbsp; <a href="index.html#FollowerService.IDs">func (s *FollowerService) IDs(params *FollowerIDParams) (*FollowerIDs, *http.Response, error)</a></dd>
  179. <dd>&nbsp; &nbsp; <a href="index.html#FollowerService.List">func (s *FollowerService) List(params *FollowerListParams) (*Followers, *http.Response, error)</a></dd>
  180. <dd><a href="index.html#Followers">type Followers</a></dd>
  181. <dd><a href="index.html#FriendsList">type FriendsList</a></dd>
  182. <dd><a href="index.html#HashtagEntity">type HashtagEntity</a></dd>
  183. <dd><a href="index.html#HomeTimelineParams">type HomeTimelineParams</a></dd>
  184. <dd><a href="index.html#Indices">type Indices</a></dd>
  185. <dd>&nbsp; &nbsp; <a href="index.html#Indices.End">func (i Indices) End() int</a></dd>
  186. <dd>&nbsp; &nbsp; <a href="index.html#Indices.Start">func (i Indices) Start() int</a></dd>
  187. <dd><a href="index.html#LocationDeletion">type LocationDeletion</a></dd>
  188. <dd><a href="index.html#MediaEntity">type MediaEntity</a></dd>
  189. <dd><a href="index.html#MentionEntity">type MentionEntity</a></dd>
  190. <dd><a href="index.html#MentionTimelineParams">type MentionTimelineParams</a></dd>
  191. <dd><a href="index.html#OEmbedTweet">type OEmbedTweet</a></dd>
  192. <dd><a href="index.html#Place">type Place</a></dd>
  193. <dd><a href="index.html#RetweetsOfMeTimelineParams">type RetweetsOfMeTimelineParams</a></dd>
  194. <dd><a href="index.html#StallWarning">type StallWarning</a></dd>
  195. <dd><a href="index.html#StatusDeletion">type StatusDeletion</a></dd>
  196. <dd><a href="index.html#StatusDestroyParams">type StatusDestroyParams</a></dd>
  197. <dd><a href="index.html#StatusLookupParams">type StatusLookupParams</a></dd>
  198. <dd><a href="index.html#StatusOEmbedParams">type StatusOEmbedParams</a></dd>
  199. <dd><a href="index.html#StatusRetweetParams">type StatusRetweetParams</a></dd>
  200. <dd><a href="index.html#StatusService">type StatusService</a></dd>
  201. <dd>&nbsp; &nbsp; <a href="index.html#StatusService.Destroy">func (s *StatusService) Destroy(id int64, params *StatusDestroyParams) (*Tweet, *http.Response, error)</a></dd>
  202. <dd>&nbsp; &nbsp; <a href="index.html#StatusService.Lookup">func (s *StatusService) Lookup(ids []int64, params *StatusLookupParams) ([]Tweet, *http.Response, error)</a></dd>
  203. <dd>&nbsp; &nbsp; <a href="index.html#StatusService.OEmbed">func (s *StatusService) OEmbed(params *StatusOEmbedParams) (*OEmbedTweet, *http.Response, error)</a></dd>
  204. <dd>&nbsp; &nbsp; <a href="index.html#StatusService.Retweet">func (s *StatusService) Retweet(id int64, params *StatusRetweetParams) (*Tweet, *http.Response, error)</a></dd>
  205. <dd>&nbsp; &nbsp; <a href="index.html#StatusService.Show">func (s *StatusService) Show(id int64, params *StatusShowParams) (*Tweet, *http.Response, error)</a></dd>
  206. <dd>&nbsp; &nbsp; <a href="index.html#StatusService.Update">func (s *StatusService) Update(status string, params *StatusUpdateParams) (*Tweet, *http.Response, error)</a></dd>
  207. <dd><a href="index.html#StatusShowParams">type StatusShowParams</a></dd>
  208. <dd><a href="index.html#StatusUpdateParams">type StatusUpdateParams</a></dd>
  209. <dd><a href="index.html#StatusWithheld">type StatusWithheld</a></dd>
  210. <dd><a href="index.html#Stream">type Stream</a></dd>
  211. <dd>&nbsp; &nbsp; <a href="index.html#Stream.Stop">func (s *Stream) Stop()</a></dd>
  212. <dd><a href="index.html#StreamDisconnect">type StreamDisconnect</a></dd>
  213. <dd><a href="index.html#StreamFilterParams">type StreamFilterParams</a></dd>
  214. <dd><a href="index.html#StreamFirehoseParams">type StreamFirehoseParams</a></dd>
  215. <dd><a href="index.html#StreamLimit">type StreamLimit</a></dd>
  216. <dd><a href="index.html#StreamSampleParams">type StreamSampleParams</a></dd>
  217. <dd><a href="index.html#StreamService">type StreamService</a></dd>
  218. <dd>&nbsp; &nbsp; <a href="index.html#StreamService.Filter">func (srv *StreamService) Filter(params *StreamFilterParams) (*Stream, error)</a></dd>
  219. <dd>&nbsp; &nbsp; <a href="index.html#StreamService.Firehose">func (srv *StreamService) Firehose(params *StreamFirehoseParams) (*Stream, error)</a></dd>
  220. <dd>&nbsp; &nbsp; <a href="index.html#StreamService.Sample">func (srv *StreamService) Sample(params *StreamSampleParams) (*Stream, error)</a></dd>
  221. <dd>&nbsp; &nbsp; <a href="index.html#StreamService.Site">func (srv *StreamService) Site(params *StreamSiteParams) (*Stream, error)</a></dd>
  222. <dd>&nbsp; &nbsp; <a href="index.html#StreamService.User">func (srv *StreamService) User(params *StreamUserParams) (*Stream, error)</a></dd>
  223. <dd><a href="index.html#StreamSiteParams">type StreamSiteParams</a></dd>
  224. <dd><a href="index.html#StreamUserParams">type StreamUserParams</a></dd>
  225. <dd><a href="index.html#SwitchDemux">type SwitchDemux</a></dd>
  226. <dd>&nbsp; &nbsp; <a href="index.html#NewSwitchDemux">func NewSwitchDemux() SwitchDemux</a></dd>
  227. <dd>&nbsp; &nbsp; <a href="index.html#SwitchDemux.Handle">func (d SwitchDemux) Handle(message interface{})</a></dd>
  228. <dd>&nbsp; &nbsp; <a href="index.html#SwitchDemux.HandleChan">func (d SwitchDemux) HandleChan(messages &lt;-chan interface{})</a></dd>
  229. <dd><a href="index.html#TimelineService">type TimelineService</a></dd>
  230. <dd>&nbsp; &nbsp; <a href="index.html#TimelineService.HomeTimeline">func (s *TimelineService) HomeTimeline(params *HomeTimelineParams) ([]Tweet, *http.Response, error)</a></dd>
  231. <dd>&nbsp; &nbsp; <a href="index.html#TimelineService.MentionTimeline">func (s *TimelineService) MentionTimeline(params *MentionTimelineParams) ([]Tweet, *http.Response, error)</a></dd>
  232. <dd>&nbsp; &nbsp; <a href="index.html#TimelineService.RetweetsOfMeTimeline">func (s *TimelineService) RetweetsOfMeTimeline(params *RetweetsOfMeTimelineParams) ([]Tweet, *http.Response, error)</a></dd>
  233. <dd>&nbsp; &nbsp; <a href="index.html#TimelineService.UserTimeline">func (s *TimelineService) UserTimeline(params *UserTimelineParams) ([]Tweet, *http.Response, error)</a></dd>
  234. <dd><a href="index.html#Tweet">type Tweet</a></dd>
  235. <dd><a href="index.html#TweetIdentifier">type TweetIdentifier</a></dd>
  236. <dd><a href="index.html#URLEntity">type URLEntity</a></dd>
  237. <dd><a href="index.html#User">type User</a></dd>
  238. <dd><a href="index.html#UserEntities">type UserEntities</a></dd>
  239. <dd><a href="index.html#UserLookupParams">type UserLookupParams</a></dd>
  240. <dd><a href="index.html#UserSearchParams">type UserSearchParams</a></dd>
  241. <dd><a href="index.html#UserService">type UserService</a></dd>
  242. <dd>&nbsp; &nbsp; <a href="index.html#UserService.Lookup">func (s *UserService) Lookup(params *UserLookupParams) ([]User, *http.Response, error)</a></dd>
  243. <dd>&nbsp; &nbsp; <a href="index.html#UserService.Search">func (s *UserService) Search(query string, params *UserSearchParams) ([]User, *http.Response, error)</a></dd>
  244. <dd>&nbsp; &nbsp; <a href="index.html#UserService.Show">func (s *UserService) Show(params *UserShowParams) (*User, *http.Response, error)</a></dd>
  245. <dd><a href="index.html#UserShowParams">type UserShowParams</a></dd>
  246. <dd><a href="index.html#UserTimelineParams">type UserTimelineParams</a></dd>
  247. <dd><a href="index.html#UserWithheld">type UserWithheld</a></dd>
  248. </dl>
  249. </div><!-- #manual-nav -->
  250. <h4>Package files</h4>
  251. <p>
  252. <span style="font-size:90%">
  253. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/accounts.go">accounts.go</a>
  254. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/backoffs.go">backoffs.go</a>
  255. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/demux.go">demux.go</a>
  256. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go">direct_messages.go</a>
  257. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/doc.go">doc.go</a>
  258. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/entities.go">entities.go</a>
  259. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/errors.go">errors.go</a>
  260. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/followers.go">followers.go</a>
  261. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go">statuses.go</a>
  262. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/stream_messages.go">stream_messages.go</a>
  263. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/stream_utils.go">stream_utils.go</a>
  264. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go">streams.go</a>
  265. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/timelines.go">timelines.go</a>
  266. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/twitter.go">twitter.go</a>
  267. <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/users.go">users.go</a>
  268. </span>
  269. </p>
  270. </div><!-- .expanded -->
  271. </div><!-- #pkg-index -->
  272. <div id="pkg-callgraph" class="toggle" style="display: none">
  273. <div class="collapsed">
  274. <h2 class="toggleButton" title="Click to show Internal Call Graph section">Internal call graph ▹</h2>
  275. </div> <!-- .expanded -->
  276. <div class="expanded">
  277. <h2 class="toggleButton" title="Click to hide Internal Call Graph section">Internal call graph ▾</h2>
  278. <p>
  279. In the call graph viewer below, each node
  280. is a function belonging to this package
  281. and its children are the functions it
  282. calls&mdash;perhaps dynamically.
  283. </p>
  284. <p>
  285. The root nodes are the entry points of the
  286. package: functions that may be called from
  287. outside the package.
  288. There may be non-exported or anonymous
  289. functions among them if they are called
  290. dynamically from another package.
  291. </p>
  292. <p>
  293. Click a node to visit that function's source code.
  294. From there you can visit its callers by
  295. clicking its declaring <code>func</code>
  296. token.
  297. </p>
  298. <p>
  299. Functions may be omitted if they were
  300. determined to be unreachable in the
  301. particular programs or tests that were
  302. analyzed.
  303. </p>
  304. <!-- Zero means show all package entry points. -->
  305. <ul style="margin-left: 0.5in" id="callgraph-0" class="treeview"></ul>
  306. </div>
  307. </div> <!-- #pkg-callgraph -->
  308. <h2 id="Bool">func <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/twitter.go?s=1083:1106#L30">Bool</a></h2>
  309. <pre>func Bool(v <a href="../../../../builtin/index.html#bool">bool</a>) *<a href="../../../../builtin/index.html#bool">bool</a></pre>
  310. <p>
  311. Bool returns a new pointer to the given bool value.
  312. </p>
  313. <h2 id="Float">func <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/twitter.go?s=1211:1241#L37">Float</a></h2>
  314. <pre>func Float(v <a href="../../../../builtin/index.html#float64">float64</a>) *<a href="../../../../builtin/index.html#float64">float64</a></pre>
  315. <p>
  316. Float returns a new pointer to the given float64 value.
  317. </p>
  318. <h2 id="APIError">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/errors.go?s=143:205#L1">APIError</a></h2>
  319. <pre>type APIError struct {
  320. Errors []<a href="index.html#ErrorDetail">ErrorDetail</a> `json:&#34;errors&#34;`
  321. }</pre>
  322. <p>
  323. APIError represents a Twitter API Error response
  324. <a href="https://dev.twitter.com/overview/api/response-codes">https://dev.twitter.com/overview/api/response-codes</a>
  325. </p>
  326. <h3 id="APIError.Empty">func (APIError) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/errors.go?s=629:659#L19">Empty</a></h3>
  327. <pre>func (e <a href="index.html#APIError">APIError</a>) Empty() <a href="../../../../builtin/index.html#bool">bool</a></pre>
  328. <p>
  329. Empty returns true if empty. Otherwise, at least 1 error message/code is
  330. present and false is returned.
  331. </p>
  332. <h3 id="APIError.Error">func (APIError) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/errors.go?s=360:392#L9">Error</a></h3>
  333. <pre>func (e <a href="index.html#APIError">APIError</a>) Error() <a href="../../../../builtin/index.html#string">string</a></pre>
  334. <h2 id="AccountService">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/accounts.go?s=144:194#L1">AccountService</a></h2>
  335. <pre>type AccountService struct {
  336. <span class="comment">// contains filtered or unexported fields</span>
  337. }</pre>
  338. <p>
  339. AccountService provides a method for account credential verification.
  340. </p>
  341. <h3 id="AccountService.VerifyCredentials">func (*AccountService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/accounts.go?s=866:968#L22">VerifyCredentials</a></h3>
  342. <pre>func (s *<a href="index.html#AccountService">AccountService</a>) VerifyCredentials(params *<a href="index.html#AccountVerifyParams">AccountVerifyParams</a>) (*<a href="index.html#User">User</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  343. <p>
  344. VerifyCredentials returns the authorized user if credentials are valid and
  345. returns an error otherwise.
  346. Requires a user auth context.
  347. <a href="https://dev.twitter.com/rest/reference/get/account/verify_credentials">https://dev.twitter.com/rest/reference/get/account/verify_credentials</a>
  348. </p>
  349. <h2 id="AccountVerifyParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/accounts.go?s=448:649#L12">AccountVerifyParams</a></h2>
  350. <pre>type AccountVerifyParams struct {
  351. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;`
  352. SkipStatus *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;skip_status,omitempty&#34;`
  353. IncludeEmail *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_email,omitempty&#34;`
  354. }</pre>
  355. <p>
  356. AccountVerifyParams are the params for AccountService.VerifyCredentials.
  357. </p>
  358. <h2 id="BoundingBox">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=3305:3423#L57">BoundingBox</a></h2>
  359. <pre>type BoundingBox struct {
  360. Coordinates [][][2]<a href="../../../../builtin/index.html#float64">float64</a> `json:&#34;coordinates&#34;`
  361. Type <a href="../../../../builtin/index.html#string">string</a> `json:&#34;type&#34;`
  362. }</pre>
  363. <p>
  364. BoundingBox represents the bounding coordinates (longitude, latitutde)
  365. defining the bounds of a box containing a Place entity.
  366. </p>
  367. <h2 id="Client">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/twitter.go?s=185:479#L2">Client</a></h2>
  368. <pre>type Client struct {
  369. <span class="comment">// Twitter API Services</span>
  370. Accounts *<a href="index.html#AccountService">AccountService</a>
  371. Statuses *<a href="index.html#StatusService">StatusService</a>
  372. Timelines *<a href="index.html#TimelineService">TimelineService</a>
  373. Users *<a href="index.html#UserService">UserService</a>
  374. Followers *<a href="index.html#FollowerService">FollowerService</a>
  375. DirectMessages *<a href="index.html#DirectMessageService">DirectMessageService</a>
  376. Streams *<a href="index.html#StreamService">StreamService</a>
  377. <span class="comment">// contains filtered or unexported fields</span>
  378. }</pre>
  379. <p>
  380. Client is a Twitter client for making Twitter API requests.
  381. </p>
  382. <h3 id="NewClient">func <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/twitter.go?s=516:563#L15">NewClient</a></h3>
  383. <pre>func NewClient(httpClient *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Client">Client</a>) *<a href="index.html#Client">Client</a></pre>
  384. <p>
  385. NewClient returns a new Client.
  386. </p>
  387. <h2 id="Contributor">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=3490:3623#L63">Contributor</a></h2>
  388. <pre>type Contributor struct {
  389. ID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;id&#34;`
  390. IDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;id_str&#34;`
  391. ScreenName <a href="../../../../builtin/index.html#string">string</a> `json:&#34;screen_name&#34;`
  392. }</pre>
  393. <p>
  394. Contributor represents a brief summary of a User identifiers.
  395. </p>
  396. <h2 id="Coordinates">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=3687:3797#L70">Coordinates</a></h2>
  397. <pre>type Coordinates struct {
  398. Coordinates [2]<a href="../../../../builtin/index.html#float64">float64</a> `json:&#34;coordinates&#34;`
  399. Type <a href="../../../../builtin/index.html#string">string</a> `json:&#34;type&#34;`
  400. }</pre>
  401. <p>
  402. Coordinates are pairs of longitude and latitude locations.
  403. </p>
  404. <h2 id="Demux">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/demux.go?s=177:271#L1">Demux</a></h2>
  405. <pre>type Demux interface {
  406. Handle(message interface{})
  407. HandleChan(messages &lt;-chan interface{})
  408. }</pre>
  409. <p>
  410. A Demux receives interface{} messages individually or from a channel and
  411. sends those messages to one or more outputs determined by the
  412. implementation.
  413. </p>
  414. <h2 id="DirectMessage">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go?s=131:716#L1">DirectMessage</a></h2>
  415. <pre>type DirectMessage struct {
  416. CreatedAt <a href="../../../../builtin/index.html#string">string</a> `json:&#34;created_at&#34;`
  417. Entities *<a href="index.html#Entities">Entities</a> `json:&#34;entities&#34;`
  418. ID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;id&#34;`
  419. IDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;id_str&#34;`
  420. Recipient *<a href="index.html#User">User</a> `json:&#34;recipient&#34;`
  421. RecipientID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;recipient_id&#34;`
  422. RecipientScreenName <a href="../../../../builtin/index.html#string">string</a> `json:&#34;recipient_screen_name&#34;`
  423. Sender *<a href="index.html#User">User</a> `json:&#34;sender&#34;`
  424. SenderID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;sender_id&#34;`
  425. SenderScreenName <a href="../../../../builtin/index.html#string">string</a> `json:&#34;sender_screen_name&#34;`
  426. Text <a href="../../../../builtin/index.html#string">string</a> `json:&#34;text&#34;`
  427. }</pre>
  428. <p>
  429. DirectMessage is a direct message to a single recipient.
  430. </p>
  431. <h2 id="DirectMessageDestroyParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go?s=4327:4471#L102">DirectMessageDestroyParams</a></h2>
  432. <pre>type DirectMessageDestroyParams struct {
  433. ID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;id,omitempty&#34;`
  434. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;`
  435. }</pre>
  436. <p>
  437. DirectMessageDestroyParams are the parameters for DirectMessageService.Destroy
  438. </p>
  439. <h2 id="DirectMessageGetParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go?s=1849:2143#L46">DirectMessageGetParams</a></h2>
  440. <pre>type DirectMessageGetParams struct {
  441. SinceID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;since_id,omitempty&#34;`
  442. MaxID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;max_id,omitempty&#34;`
  443. Count <a href="../../../../builtin/index.html#int">int</a> `url:&#34;count,omitempty&#34;`
  444. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;`
  445. SkipStatus *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;skip_status,omitempty&#34;`
  446. }</pre>
  447. <p>
  448. DirectMessageGetParams are the parameters for DirectMessageService.Get
  449. </p>
  450. <h2 id="DirectMessageNewParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go?s=3584:3748#L84">DirectMessageNewParams</a></h2>
  451. <pre>type DirectMessageNewParams struct {
  452. UserID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;user_id,omitempty&#34;`
  453. ScreenName <a href="../../../../builtin/index.html#string">string</a> `url:&#34;screen_name,omitempty&#34;`
  454. Text <a href="../../../../builtin/index.html#string">string</a> `url:&#34;text&#34;`
  455. }</pre>
  456. <p>
  457. DirectMessageNewParams are the parameters for DirectMessageService.New
  458. </p>
  459. <h2 id="DirectMessageSentParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go?s=2726:3014#L65">DirectMessageSentParams</a></h2>
  460. <pre>type DirectMessageSentParams struct {
  461. SinceID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;since_id,omitempty&#34;`
  462. MaxID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;max_id,omitempty&#34;`
  463. Count <a href="../../../../builtin/index.html#int">int</a> `url:&#34;count,omitempty&#34;`
  464. Page <a href="../../../../builtin/index.html#int">int</a> `url:&#34;page,omitempty&#34;`
  465. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;`
  466. }</pre>
  467. <p>
  468. DirectMessageSentParams are the parameters for DirectMessageService.Sent
  469. </p>
  470. <h2 id="DirectMessageService">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go?s=814:898#L16">DirectMessageService</a></h2>
  471. <pre>type DirectMessageService struct {
  472. <span class="comment">// contains filtered or unexported fields</span>
  473. }</pre>
  474. <p>
  475. DirectMessageService provides methods for accessing Twitter direct message
  476. API endpoints.
  477. </p>
  478. <h3 id="DirectMessageService.Destroy">func (*DirectMessageService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go?s=4680:4804#L111">Destroy</a></h3>
  479. <pre>func (s *<a href="index.html#DirectMessageService">DirectMessageService</a>) Destroy(id <a href="../../../../builtin/index.html#int64">int64</a>, params *<a href="index.html#DirectMessageDestroyParams">DirectMessageDestroyParams</a>) (*<a href="index.html#DirectMessage">DirectMessage</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  480. <p>
  481. Destroy deletes the Direct Message with the given id and returns it if
  482. successful.
  483. Requires a user auth context with DM scope.
  484. <a href="https://dev.twitter.com/rest/reference/post/direct_messages/destroy">https://dev.twitter.com/rest/reference/post/direct_messages/destroy</a>
  485. </p>
  486. <h3 id="DirectMessageService.Get">func (*DirectMessageService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go?s=2328:2435#L57">Get</a></h3>
  487. <pre>func (s *<a href="index.html#DirectMessageService">DirectMessageService</a>) Get(params *<a href="index.html#DirectMessageGetParams">DirectMessageGetParams</a>) ([]<a href="index.html#DirectMessage">DirectMessage</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  488. <p>
  489. Get returns recent Direct Messages received by the authenticated user.
  490. Requires a user auth context with DM scope.
  491. <a href="https://dev.twitter.com/rest/reference/get/direct_messages">https://dev.twitter.com/rest/reference/get/direct_messages</a>
  492. </p>
  493. <h3 id="DirectMessageService.New">func (*DirectMessageService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go?s=3948:4054#L94">New</a></h3>
  494. <pre>func (s *<a href="index.html#DirectMessageService">DirectMessageService</a>) New(params *<a href="index.html#DirectMessageNewParams">DirectMessageNewParams</a>) (*<a href="index.html#DirectMessage">DirectMessage</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  495. <p>
  496. New sends a new Direct Message to a specified user as the authenticated
  497. user.
  498. Requires a user auth context with DM scope.
  499. <a href="https://dev.twitter.com/rest/reference/post/direct_messages/new">https://dev.twitter.com/rest/reference/post/direct_messages/new</a>
  500. </p>
  501. <h3 id="DirectMessageService.Sent">func (*DirectMessageService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go?s=3201:3310#L76">Sent</a></h3>
  502. <pre>func (s *<a href="index.html#DirectMessageService">DirectMessageService</a>) Sent(params *<a href="index.html#DirectMessageSentParams">DirectMessageSentParams</a>) ([]<a href="index.html#DirectMessage">DirectMessage</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  503. <p>
  504. Sent returns recent Direct Messages sent by the authenticated user.
  505. Requires a user auth context with DM scope.
  506. <a href="https://dev.twitter.com/rest/reference/get/direct_messages/sent">https://dev.twitter.com/rest/reference/get/direct_messages/sent</a>
  507. </p>
  508. <h3 id="DirectMessageService.Show">func (*DirectMessageService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/direct_messages.go?s=1452:1537#L37">Show</a></h3>
  509. <pre>func (s *<a href="index.html#DirectMessageService">DirectMessageService</a>) Show(id <a href="../../../../builtin/index.html#int64">int64</a>) (*<a href="index.html#DirectMessage">DirectMessage</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  510. <p>
  511. Show returns the requested Direct Message.
  512. Requires a user auth context with DM scope.
  513. <a href="https://dev.twitter.com/rest/reference/get/direct_messages/show">https://dev.twitter.com/rest/reference/get/direct_messages/show</a>
  514. </p>
  515. <h2 id="Entities">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/entities.go?s=163:377#L1">Entities</a></h2>
  516. <pre>type Entities struct {
  517. Hashtags []<a href="index.html#HashtagEntity">HashtagEntity</a> `json:&#34;hashtags&#34;`
  518. Media []<a href="index.html#MediaEntity">MediaEntity</a> `json:&#34;media&#34;`
  519. Urls []<a href="index.html#URLEntity">URLEntity</a> `json:&#34;urls&#34;`
  520. UserMentions []<a href="index.html#MentionEntity">MentionEntity</a> `json:&#34;user_mentions&#34;`
  521. }</pre>
  522. <p>
  523. Entities represent metadata and context info parsed from Twitter components.
  524. <a href="https://dev.twitter.com/overview/api/entities">https://dev.twitter.com/overview/api/entities</a>
  525. TODO: symbols
  526. </p>
  527. <h2 id="ErrorDetail">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/errors.go?s=268:358#L4">ErrorDetail</a></h2>
  528. <pre>type ErrorDetail struct {
  529. Message <a href="../../../../builtin/index.html#string">string</a> `json:&#34;message&#34;`
  530. Code <a href="../../../../builtin/index.html#int">int</a> `json:&#34;code&#34;`
  531. }</pre>
  532. <p>
  533. ErrorDetail represents an individual item in an APIError.
  534. </p>
  535. <h2 id="Event">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/stream_messages.go?s=3394:3633#L93">Event</a></h2>
  536. <pre>type Event struct {
  537. Event <a href="../../../../builtin/index.html#string">string</a> `json:&#34;event&#34;`
  538. CreatedAt <a href="../../../../builtin/index.html#string">string</a> `json:&#34;created_at&#34;`
  539. Target *<a href="index.html#User">User</a> `json:&#34;target&#34;`
  540. Source *<a href="index.html#User">User</a> `json:&#34;source&#34;`
  541. <span class="comment">// TODO: add List or deprecate it</span>
  542. TargetObject *<a href="index.html#Tweet">Tweet</a> `json:&#34;target_object&#34;`
  543. }</pre>
  544. <p>
  545. Event is a non-Tweet notification message (e.g. like, retweet, follow).
  546. <a href="https://dev.twitter.com/streaming/overview/messages-types#Events_event">https://dev.twitter.com/streaming/overview/messages-types#Events_event</a>
  547. </p>
  548. <h2 id="ExtendedEntity">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/entities.go?s=1913:1979#L48">ExtendedEntity</a></h2>
  549. <pre>type ExtendedEntity struct {
  550. Media []<a href="index.html#MediaEntity">MediaEntity</a> `json:&#34;media&#34;`
  551. }</pre>
  552. <p>
  553. ExtendedEntity contains media information.
  554. <a href="https://dev.twitter.com/overview/api/entities-in-twitter-objects#extended_entities">https://dev.twitter.com/overview/api/entities-in-twitter-objects#extended_entities</a>
  555. </p>
  556. <h2 id="FollowerIDParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/followers.go?s=1107:1320#L30">FollowerIDParams</a></h2>
  557. <pre>type FollowerIDParams struct {
  558. UserID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;user_id,omitempty&#34;`
  559. ScreenName <a href="../../../../builtin/index.html#string">string</a> `url:&#34;screen_name,omitempty&#34;`
  560. Cursor <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;cursor,omitempty&#34;`
  561. Count <a href="../../../../builtin/index.html#int">int</a> `url:&#34;count,omitempty&#34;`
  562. }</pre>
  563. <p>
  564. FollowerIDParams are the parameters for FollowerService.Ids
  565. </p>
  566. <h2 id="FollowerIDs">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/followers.go?s=128:403#L1">FollowerIDs</a></h2>
  567. <pre>type FollowerIDs struct {
  568. IDs []<a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;ids&#34;`
  569. NextCursor <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;next_cursor&#34;`
  570. NextCursorStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;next_cursor_str&#34;`
  571. PreviousCursor <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;previous_cursor&#34;`
  572. PreviousCursorStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;previous_cursor_str&#34;`
  573. }</pre>
  574. <p>
  575. FollowerIDs is a cursored collection of follower ids.
  576. </p>
  577. <h2 id="FollowerListParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/followers.go?s=1814:2191#L47">FollowerListParams</a></h2>
  578. <pre>type FollowerListParams struct {
  579. UserID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;user_id,omitempty&#34;`
  580. ScreenName <a href="../../../../builtin/index.html#string">string</a> `url:&#34;screen_name,omitempty&#34;`
  581. Cursor <a href="../../../../builtin/index.html#int">int</a> `url:&#34;cursor,omitempty&#34;`
  582. Count <a href="../../../../builtin/index.html#int">int</a> `url:&#34;count,omitempty&#34;`
  583. SkipStatus *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;skip_status,omitempty&#34;`
  584. IncludeUserEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_user_entities,omitempty&#34;`
  585. }</pre>
  586. <p>
  587. FollowerListParams are the parameters for FollowerService.List
  588. </p>
  589. <h2 id="FollowerService">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/followers.go?s=808:859#L18">FollowerService</a></h2>
  590. <pre>type FollowerService struct {
  591. <span class="comment">// contains filtered or unexported fields</span>
  592. }</pre>
  593. <p>
  594. FollowerService provides methods for accessing Twitter followers endpoints.
  595. </p>
  596. <h3 id="FollowerService.IDs">func (*FollowerService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/followers.go?s=1461:1554#L39">IDs</a></h3>
  597. <pre>func (s *<a href="index.html#FollowerService">FollowerService</a>) IDs(params *<a href="index.html#FollowerIDParams">FollowerIDParams</a>) (*<a href="index.html#FollowerIDs">FollowerIDs</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  598. <p>
  599. IDs returns a cursored collection of user ids following the specified user.
  600. <a href="https://dev.twitter.com/rest/reference/get/followers/ids">https://dev.twitter.com/rest/reference/get/followers/ids</a>
  601. </p>
  602. <h3 id="FollowerService.List">func (*FollowerService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/followers.go?s=2331:2425#L58">List</a></h3>
  603. <pre>func (s *<a href="index.html#FollowerService">FollowerService</a>) List(params *<a href="index.html#FollowerListParams">FollowerListParams</a>) (*<a href="index.html#Followers">Followers</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  604. <p>
  605. List returns a cursored collection of Users following the specified user.
  606. <a href="https://dev.twitter.com/rest/reference/get/followers/list">https://dev.twitter.com/rest/reference/get/followers/list</a>
  607. </p>
  608. <h2 id="Followers">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/followers.go?s=457:727#L9">Followers</a></h2>
  609. <pre>type Followers struct {
  610. Users []<a href="index.html#User">User</a> `json:&#34;users&#34;`
  611. NextCursor <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;next_cursor&#34;`
  612. NextCursorStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;next_cursor_str&#34;`
  613. PreviousCursor <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;previous_cursor&#34;`
  614. PreviousCursorStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;previous_cursor_str&#34;`
  615. }</pre>
  616. <p>
  617. Followers is a cursored collection of followers.
  618. </p>
  619. <h2 id="FriendsList">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/stream_messages.go?s=3091:3152#L83">FriendsList</a></h2>
  620. <pre>type FriendsList struct {
  621. Friends []<a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;friends&#34;`
  622. }</pre>
  623. <p>
  624. FriendsList is a list of some of a user&#39;s friends.
  625. <a href="https://dev.twitter.com/streaming/overview/messages-types#friends_list_friends">https://dev.twitter.com/streaming/overview/messages-types#friends_list_friends</a>
  626. </p>
  627. <h2 id="HashtagEntity">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/entities.go?s=450:544#L4">HashtagEntity</a></h2>
  628. <pre>type HashtagEntity struct {
  629. Indices <a href="index.html#Indices">Indices</a> `json:&#34;indices&#34;`
  630. Text <a href="../../../../builtin/index.html#string">string</a> `json:&#34;text&#34;`
  631. }</pre>
  632. <p>
  633. HashtagEntity represents a hashtag which has been parsed from text.
  634. </p>
  635. <h2 id="HomeTimelineParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/timelines.go?s=1530:1957#L35">HomeTimelineParams</a></h2>
  636. <pre>type HomeTimelineParams struct {
  637. Count <a href="../../../../builtin/index.html#int">int</a> `url:&#34;count,omitempty&#34;`
  638. SinceID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;since_id,omitempty&#34;`
  639. MaxID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;max_id,omitempty&#34;`
  640. TrimUser *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;trim_user,omitempty&#34;`
  641. ExcludeReplies *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;exclude_replies,omitempty&#34;`
  642. ContributorDetails *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;contributor_details,omitempty&#34;`
  643. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;`
  644. }</pre>
  645. <p>
  646. HomeTimelineParams are the parameters for TimelineService.HomeTimeline.
  647. </p>
  648. <h2 id="Indices">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/entities.go?s=2041:2060#L53">Indices</a></h2>
  649. <pre>type Indices [2]<a href="../../../../builtin/index.html#int">int</a></pre>
  650. <p>
  651. Indices represent the start and end offsets within text.
  652. </p>
  653. <h3 id="Indices.End">func (Indices) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/entities.go?s=2235:2261#L61">End</a></h3>
  654. <pre>func (i <a href="index.html#Indices">Indices</a>) End() <a href="../../../../builtin/index.html#int">int</a></pre>
  655. <p>
  656. End returns the index at which an entity ends, exclusive.
  657. </p>
  658. <h3 id="Indices.Start">func (Indices) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/entities.go?s=2127:2155#L56">Start</a></h3>
  659. <pre>func (i <a href="index.html#Indices">Indices</a>) Start() <a href="../../../../builtin/index.html#int">int</a></pre>
  660. <p>
  661. Start returns the index at which an entity starts, inclusive.
  662. </p>
  663. <h2 id="LocationDeletion">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/stream_messages.go?s=655:875#L11">LocationDeletion</a></h2>
  664. <pre>type LocationDeletion struct {
  665. UserID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;user_id&#34;`
  666. UserIDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;user_id_str&#34;`
  667. UpToStatusID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;up_to_status_id&#34;`
  668. UpToStatusIDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;up_to_status_id_str&#34;`
  669. }</pre>
  670. <p>
  671. LocationDeletion indicates geolocation data must be stripped from a range
  672. of Tweets.
  673. <a href="https://dev.twitter.com/streaming/overview/messages-types#Location_deletion_notices_scrub_geo">https://dev.twitter.com/streaming/overview/messages-types#Location_deletion_notices_scrub_geo</a>
  674. </p>
  675. <h2 id="MediaEntity">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/entities.go?s=878:1240#L19">MediaEntity</a></h2>
  676. <pre>type MediaEntity struct {
  677. <a href="index.html#URLEntity">URLEntity</a>
  678. ID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;id&#34;`
  679. IDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;id_str&#34;`
  680. MediaURL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;media_url&#34;`
  681. MediaURLHttps <a href="../../../../builtin/index.html#string">string</a> `json:&#34;media_url_https&#34;`
  682. SourceStatusID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;source_status_id&#34;`
  683. SourceStatusIDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;source_status_id_str&#34;`
  684. Type <a href="../../../../builtin/index.html#string">string</a> `json:&#34;type&#34;`
  685. }</pre>
  686. <p>
  687. MediaEntity represents media elements associated with a Tweet.
  688. TODO: add Sizes
  689. </p>
  690. <h2 id="MentionEntity">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/entities.go?s=1310:1519#L31">MentionEntity</a></h2>
  691. <pre>type MentionEntity struct {
  692. Indices <a href="index.html#Indices">Indices</a> `json:&#34;indices&#34;`
  693. ID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;id&#34;`
  694. IDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;id_str&#34;`
  695. Name <a href="../../../../builtin/index.html#string">string</a> `json:&#34;name&#34;`
  696. ScreenName <a href="../../../../builtin/index.html#string">string</a> `json:&#34;screen_name&#34;`
  697. }</pre>
  698. <p>
  699. MentionEntity represents Twitter user mentions parsed from text.
  700. </p>
  701. <h2 id="MentionTimelineParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/timelines.go?s=2548:2918#L57">MentionTimelineParams</a></h2>
  702. <pre>type MentionTimelineParams struct {
  703. Count <a href="../../../../builtin/index.html#int">int</a> `url:&#34;count,omitempty&#34;`
  704. SinceID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;since_id,omitempty&#34;`
  705. MaxID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;max_id,omitempty&#34;`
  706. TrimUser *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;trim_user,omitempty&#34;`
  707. ContributorDetails *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;contributor_details,omitempty&#34;`
  708. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;`
  709. }</pre>
  710. <p>
  711. MentionTimelineParams are the parameters for TimelineService.MentionTimeline.
  712. </p>
  713. <h2 id="OEmbedTweet">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=8753:9205#L207">OEmbedTweet</a></h2>
  714. <pre>type OEmbedTweet struct {
  715. URL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;url&#34;`
  716. ProviderURL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;provider_url&#34;`
  717. ProviderName <a href="../../../../builtin/index.html#string">string</a> `json:&#34;provider_name&#34;`
  718. AuthorName <a href="../../../../builtin/index.html#string">string</a> `json:&#34;author_name&#34;`
  719. Version <a href="../../../../builtin/index.html#string">string</a> `json:&#34;version&#34;`
  720. AuthorURL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;author_url&#34;`
  721. Type <a href="../../../../builtin/index.html#string">string</a> `json:&#34;type&#34;`
  722. HTML <a href="../../../../builtin/index.html#string">string</a> `json:&#34;html&#34;`
  723. Height <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;height&#34;`
  724. Width <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;width&#34;`
  725. CacheAge <a href="../../../../builtin/index.html#string">string</a> `json:&#34;cache_age&#34;`
  726. }</pre>
  727. <p>
  728. OEmbedTweet represents a Tweet in oEmbed format.
  729. </p>
  730. <h2 id="Place">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=2612:3170#L41">Place</a></h2>
  731. <pre>type Place struct {
  732. Attributes map[<a href="../../../../builtin/index.html#string">string</a>]<a href="../../../../builtin/index.html#string">string</a> `json:&#34;attributes&#34;`
  733. BoundingBox *<a href="index.html#BoundingBox">BoundingBox</a> `json:&#34;bounding_box&#34;`
  734. Country <a href="../../../../builtin/index.html#string">string</a> `json:&#34;country&#34;`
  735. CountryCode <a href="../../../../builtin/index.html#string">string</a> `json:&#34;country_code&#34;`
  736. FullName <a href="../../../../builtin/index.html#string">string</a> `json:&#34;full_name&#34;`
  737. Geometry *<a href="index.html#BoundingBox">BoundingBox</a> `json:&#34;geometry&#34;`
  738. ID <a href="../../../../builtin/index.html#string">string</a> `json:&#34;id&#34;`
  739. Name <a href="../../../../builtin/index.html#string">string</a> `json:&#34;name&#34;`
  740. PlaceType <a href="../../../../builtin/index.html#string">string</a> `json:&#34;place_type&#34;`
  741. Polylines []<a href="../../../../builtin/index.html#string">string</a> `json:&#34;polylines&#34;`
  742. URL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;url&#34;`
  743. }</pre>
  744. <p>
  745. Place represents a Twitter Place / Location
  746. <a href="https://dev.twitter.com/overview/api/places">https://dev.twitter.com/overview/api/places</a>
  747. </p>
  748. <h2 id="RetweetsOfMeTimelineParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/timelines.go?s=3515:3888#L78">RetweetsOfMeTimelineParams</a></h2>
  749. <pre>type RetweetsOfMeTimelineParams struct {
  750. Count <a href="../../../../builtin/index.html#int">int</a> `url:&#34;count,omitempty&#34;`
  751. SinceID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;since_id,omitempty&#34;`
  752. MaxID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;max_id,omitempty&#34;`
  753. TrimUser *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;trim_user,omitempty&#34;`
  754. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;`
  755. IncludeUserEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_user_entities&#34;`
  756. }</pre>
  757. <p>
  758. RetweetsOfMeTimelineParams are the parameters for
  759. TimelineService.RetweetsOfMeTimeline.
  760. </p>
  761. <h2 id="StallWarning">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/stream_messages.go?s=2731:2872#L71">StallWarning</a></h2>
  762. <pre>type StallWarning struct {
  763. Code <a href="../../../../builtin/index.html#string">string</a> `json:&#34;code&#34;`
  764. Message <a href="../../../../builtin/index.html#string">string</a> `json:&#34;message&#34;`
  765. PercentFull <a href="../../../../builtin/index.html#int">int</a> `json:&#34;percent_full&#34;`
  766. }</pre>
  767. <p>
  768. StallWarning indicates the client is falling behind in the stream.
  769. <a href="https://dev.twitter.com/streaming/overview/messages-types#stall_warnings">https://dev.twitter.com/streaming/overview/messages-types#stall_warnings</a>
  770. </p>
  771. <h2 id="StatusDeletion">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/stream_messages.go?s=174:342#L1">StatusDeletion</a></h2>
  772. <pre>type StatusDeletion struct {
  773. ID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;id&#34;`
  774. IDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;id_str&#34;`
  775. UserID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;user_id&#34;`
  776. UserIDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;user_id_str&#34;`
  777. }</pre>
  778. <p>
  779. StatusDeletion indicates that a given Tweet has been deleted.
  780. <a href="https://dev.twitter.com/streaming/overview/messages-types#status_deletion_notices_delete">https://dev.twitter.com/streaming/overview/messages-types#status_deletion_notices_delete</a>
  781. </p>
  782. <h2 id="StatusDestroyParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=7991:8107#L186">StatusDestroyParams</a></h2>
  783. <pre>type StatusDestroyParams struct {
  784. ID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;id,omitempty&#34;`
  785. TrimUser *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;trim_user,omitempty&#34;`
  786. }</pre>
  787. <p>
  788. StatusDestroyParams are the parameters for StatusService.Destroy
  789. </p>
  790. <h2 id="StatusLookupParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=5105:5351#L115">StatusLookupParams</a></h2>
  791. <pre>type StatusLookupParams struct {
  792. ID []<a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;id,omitempty,comma&#34;`
  793. TrimUser *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;trim_user,omitempty&#34;`
  794. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;`
  795. Map *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;map,omitempty&#34;`
  796. }</pre>
  797. <p>
  798. StatusLookupParams are the parameters for StatusService.Lookup
  799. </p>
  800. <h2 id="StatusOEmbedParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=9273:9718#L222">StatusOEmbedParams</a></h2>
  801. <pre>type StatusOEmbedParams struct {
  802. ID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;id,omitempty&#34;`
  803. URL <a href="../../../../builtin/index.html#string">string</a> `url:&#34;url,omitempty&#34;`
  804. Align <a href="../../../../builtin/index.html#string">string</a> `url:&#34;align,omitempty&#34;`
  805. MaxWidth <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;maxwidth,omitempty&#34;`
  806. HideMedia *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;hide_media,omitempty&#34;`
  807. HideThread *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;hide_media,omitempty&#34;`
  808. OmitScript *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;hide_media,omitempty&#34;`
  809. WidgetType <a href="../../../../builtin/index.html#string">string</a> `url:&#34;widget_type,omitempty&#34;`
  810. HideTweet *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;hide_tweet,omitempty&#34;`
  811. }</pre>
  812. <p>
  813. StatusOEmbedParams are the parameters for StatusService.OEmbed
  814. </p>
  815. <h2 id="StatusRetweetParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=7177:7293#L164">StatusRetweetParams</a></h2>
  816. <pre>type StatusRetweetParams struct {
  817. ID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;id,omitempty&#34;`
  818. TrimUser *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;trim_user,omitempty&#34;`
  819. }</pre>
  820. <p>
  821. StatusRetweetParams are the parameters for StatusService.Retweet
  822. </p>
  823. <h2 id="StatusService">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=4039:4088#L82">StatusService</a></h2>
  824. <pre>type StatusService struct {
  825. <span class="comment">// contains filtered or unexported fields</span>
  826. }</pre>
  827. <p>
  828. StatusService provides methods for accessing Twitter status API endpoints.
  829. </p>
  830. <h3 id="StatusService.Destroy">func (*StatusService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=8289:8391#L194">Destroy</a></h3>
  831. <pre>func (s *<a href="index.html#StatusService">StatusService</a>) Destroy(id <a href="../../../../builtin/index.html#int64">int64</a>, params *<a href="index.html#StatusDestroyParams">StatusDestroyParams</a>) (*<a href="index.html#Tweet">Tweet</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  832. <p>
  833. Destroy deletes the Tweet with the given id and returns it if successful.
  834. Requires a user auth context.
  835. <a href="https://dev.twitter.com/rest/reference/post/statuses/destroy/%3Aid">https://dev.twitter.com/rest/reference/post/statuses/destroy/%3Aid</a>
  836. </p>
  837. <h3 id="StatusService.Lookup">func (*StatusService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=5533:5637#L125">Lookup</a></h3>
  838. <pre>func (s *<a href="index.html#StatusService">StatusService</a>) Lookup(ids []<a href="../../../../builtin/index.html#int64">int64</a>, params *<a href="index.html#StatusLookupParams">StatusLookupParams</a>) ([]<a href="index.html#Tweet">Tweet</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  839. <p>
  840. Lookup returns the requested Tweets as a slice. Combines ids from the
  841. required ids argument and from params.Id.
  842. <a href="https://dev.twitter.com/rest/reference/get/statuses/lookup">https://dev.twitter.com/rest/reference/get/statuses/lookup</a>
  843. </p>
  844. <h3 id="StatusService.OEmbed">func (*StatusService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=9838:9934#L236">OEmbed</a></h3>
  845. <pre>func (s *<a href="index.html#StatusService">StatusService</a>) OEmbed(params *<a href="index.html#StatusOEmbedParams">StatusOEmbedParams</a>) (*<a href="index.html#OEmbedTweet">OEmbedTweet</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  846. <p>
  847. OEmbed returns the requested Tweet in oEmbed format.
  848. <a href="https://dev.twitter.com/rest/reference/get/statuses/oembed">https://dev.twitter.com/rest/reference/get/statuses/oembed</a>
  849. </p>
  850. <h3 id="StatusService.Retweet">func (*StatusService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=7511:7613#L173">Retweet</a></h3>
  851. <pre>func (s *<a href="index.html#StatusService">StatusService</a>) Retweet(id <a href="../../../../builtin/index.html#int64">int64</a>, params *<a href="index.html#StatusRetweetParams">StatusRetweetParams</a>) (*<a href="index.html#Tweet">Tweet</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  852. <p>
  853. Retweet retweets the Tweet with the given id and returns the original Tweet
  854. with embedded retweet details.
  855. Requires a user auth context.
  856. <a href="https://dev.twitter.com/rest/reference/post/statuses/retweet/%3Aid">https://dev.twitter.com/rest/reference/post/statuses/retweet/%3Aid</a>
  857. </p>
  858. <h3 id="StatusService.Show">func (*StatusService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=4678:4774#L103">Show</a></h3>
  859. <pre>func (s *<a href="index.html#StatusService">StatusService</a>) Show(id <a href="../../../../builtin/index.html#int64">int64</a>, params *<a href="index.html#StatusShowParams">StatusShowParams</a>) (*<a href="index.html#Tweet">Tweet</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  860. <p>
  861. Show returns the requested Tweet.
  862. <a href="https://dev.twitter.com/rest/reference/get/statuses/show/%3Aid">https://dev.twitter.com/rest/reference/get/statuses/show/%3Aid</a>
  863. </p>
  864. <h3 id="StatusService.Update">func (*StatusService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=6729:6834#L152">Update</a></h3>
  865. <pre>func (s *<a href="index.html#StatusService">StatusService</a>) Update(status <a href="../../../../builtin/index.html#string">string</a>, params *<a href="index.html#StatusUpdateParams">StatusUpdateParams</a>) (*<a href="index.html#Tweet">Tweet</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  866. <p>
  867. Update updates the user&#39;s status, also known as Tweeting.
  868. Requires a user auth context.
  869. <a href="https://dev.twitter.com/rest/reference/post/statuses/update">https://dev.twitter.com/rest/reference/post/statuses/update</a>
  870. </p>
  871. <h2 id="StatusShowParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=4324:4573#L94">StatusShowParams</a></h2>
  872. <pre>type StatusShowParams struct {
  873. ID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;id,omitempty&#34;`
  874. TrimUser *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;trim_user,omitempty&#34;`
  875. IncludeMyRetweet *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_my_retweet,omitempty&#34;`
  876. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;`
  877. }</pre>
  878. <p>
  879. StatusShowParams are the parameters for StatusService.Show
  880. </p>
  881. <h2 id="StatusUpdateParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=6001:6570#L137">StatusUpdateParams</a></h2>
  882. <pre>type StatusUpdateParams struct {
  883. Status <a href="../../../../builtin/index.html#string">string</a> `url:&#34;status,omitempty&#34;`
  884. InReplyToStatusID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;in_reply_to_status_id,omitempty&#34;`
  885. PossiblySensitive *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;possibly_sensitive,omitempty&#34;`
  886. Lat *<a href="../../../../builtin/index.html#float64">float64</a> `url:&#34;lat,omitempty&#34;`
  887. Long *<a href="../../../../builtin/index.html#float64">float64</a> `url:&#34;long,omitempty&#34;`
  888. PlaceID <a href="../../../../builtin/index.html#string">string</a> `url:&#34;place_id,omitempty&#34;`
  889. DisplayCoordinates *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;display_coordinates,omitempty&#34;`
  890. TrimUser *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;trim_user,omitempty&#34;`
  891. MediaIds []<a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;media_ids,omitempty,comma&#34;`
  892. }</pre>
  893. <p>
  894. StatusUpdateParams are the parameters for StatusService.Update
  895. </p>
  896. <h2 id="StatusWithheld">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/stream_messages.go?s=1514:1694#L36">StatusWithheld</a></h2>
  897. <pre>type StatusWithheld struct {
  898. ID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;id&#34;`
  899. UserID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;user_id&#34;`
  900. WithheldInCountries []<a href="../../../../builtin/index.html#string">string</a> `json:&#34;withheld_in_countries&#34;`
  901. }</pre>
  902. <p>
  903. StatusWithheld indicates a Tweet with the given ID, belonging to UserId,
  904. has been withheld in certain countries.
  905. <a href="https://dev.twitter.com/streaming/overview/messages-types#withheld_content_notices">https://dev.twitter.com/streaming/overview/messages-types#withheld_content_notices</a>
  906. </p>
  907. <h2 id="Stream">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=5010:5152#L134">Stream</a></h2>
  908. <pre>type Stream struct {
  909. Messages chan interface{}
  910. <span class="comment">// contains filtered or unexported fields</span>
  911. }</pre>
  912. <p>
  913. Stream maintains a connection to the Twitter Streaming API, receives
  914. messages from the streaming response, and sends them on the Messages
  915. channel from a goroutine. The stream goroutine stops itself if an EOF is
  916. reached or retry errors occur, also closing the Messages channel.
  917. </p>
  918. <p>
  919. The client must Stop() the stream when finished receiving, which will
  920. wait until the stream is properly stopped.
  921. </p>
  922. <h3 id="Stream.Stop">func (*Stream) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=5767:5790#L159">Stop</a></h3>
  923. <pre>func (s *<a href="index.html#Stream">Stream</a>) Stop()</pre>
  924. <p>
  925. Stop signals retry and receiver to stop, closes the Messages channel, and
  926. blocks until done.
  927. </p>
  928. <h2 id="StreamDisconnect">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/stream_messages.go?s=2347:2487#L59">StreamDisconnect</a></h2>
  929. <pre>type StreamDisconnect struct {
  930. Code <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;code&#34;`
  931. StreamName <a href="../../../../builtin/index.html#string">string</a> `json:&#34;stream_name&#34;`
  932. Reason <a href="../../../../builtin/index.html#string">string</a> `json:&#34;reason&#34;`
  933. }</pre>
  934. <p>
  935. StreamDisconnect indicates the stream has been shutdown for some reason.
  936. <a href="https://dev.twitter.com/streaming/overview/messages-types#disconnect_messages">https://dev.twitter.com/streaming/overview/messages-types#disconnect_messages</a>
  937. </p>
  938. <h2 id="StreamFilterParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=959:1329#L32">StreamFilterParams</a></h2>
  939. <pre>type StreamFilterParams struct {
  940. FilterLevel <a href="../../../../builtin/index.html#string">string</a> `url:&#34;filter_level,omitempty&#34;`
  941. Follow []<a href="../../../../builtin/index.html#string">string</a> `url:&#34;follow,omitempty,comma&#34;`
  942. Language []<a href="../../../../builtin/index.html#string">string</a> `url:&#34;language,omitempty,comma&#34;`
  943. Locations []<a href="../../../../builtin/index.html#string">string</a> `url:&#34;locations,omitempty,comma&#34;`
  944. StallWarnings *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;stall_warnings,omitempty&#34;`
  945. Track []<a href="../../../../builtin/index.html#string">string</a> `url:&#34;track,omitempty,comma&#34;`
  946. }</pre>
  947. <p>
  948. StreamFilterParams are parameters for StreamService.Filter.
  949. </p>
  950. <h2 id="StreamFirehoseParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=3933:4186#L109">StreamFirehoseParams</a></h2>
  951. <pre>type StreamFirehoseParams struct {
  952. Count <a href="../../../../builtin/index.html#int">int</a> `url:&#34;count,omitempty&#34;`
  953. FilterLevel <a href="../../../../builtin/index.html#string">string</a> `url:&#34;filter_level,omitempty&#34;`
  954. Language []<a href="../../../../builtin/index.html#string">string</a> `url:&#34;language,omitempty,comma&#34;`
  955. StallWarnings *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;stall_warnings,omitempty&#34;`
  956. }</pre>
  957. <p>
  958. StreamFirehoseParams are the parameters for StreamService.Firehose.
  959. </p>
  960. <h2 id="StreamLimit">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/stream_messages.go?s=1182:1237#L25">StreamLimit</a></h2>
  961. <pre>type StreamLimit struct {
  962. Track <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;track&#34;`
  963. }</pre>
  964. <p>
  965. StreamLimit indicates a stream matched more statuses than its rate limit
  966. allowed. The track number is the number of undelivered matches.
  967. <a href="https://dev.twitter.com/streaming/overview/messages-types#limit_notices">https://dev.twitter.com/streaming/overview/messages-types#limit_notices</a>
  968. </p>
  969. <h2 id="StreamSampleParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=1776:1864#L52">StreamSampleParams</a></h2>
  970. <pre>type StreamSampleParams struct {
  971. StallWarnings *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;stall_warnings,omitempty&#34;`
  972. }</pre>
  973. <p>
  974. StreamSampleParams are the parameters for StreamService.Sample.
  975. </p>
  976. <h2 id="StreamService">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=428:541#L13">StreamService</a></h2>
  977. <pre>type StreamService struct {
  978. <span class="comment">// contains filtered or unexported fields</span>
  979. }</pre>
  980. <p>
  981. StreamService provides methods for accessing the Twitter Streaming API.
  982. </p>
  983. <h3 id="StreamService.Filter">func (*StreamService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=1468:1545#L43">Filter</a></h3>
  984. <pre>func (srv *<a href="index.html#StreamService">StreamService</a>) Filter(params *<a href="index.html#StreamFilterParams">StreamFilterParams</a>) (*<a href="index.html#Stream">Stream</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  985. <p>
  986. Filter returns messages that match one or more filter predicates.
  987. <a href="https://dev.twitter.com/streaming/reference/post/statuses/filter">https://dev.twitter.com/streaming/reference/post/statuses/filter</a>
  988. </p>
  989. <h3 id="StreamService.Firehose">func (*StreamService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=4353:4434#L119">Firehose</a></h3>
  990. <pre>func (srv *<a href="index.html#StreamService">StreamService</a>) Firehose(params *<a href="index.html#StreamFirehoseParams">StreamFirehoseParams</a>) (*<a href="index.html#Stream">Stream</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  991. <p>
  992. Firehose returns all public messages and statuses.
  993. Requires special permission to access.
  994. <a href="https://dev.twitter.com/streaming/reference/get/statuses/firehose">https://dev.twitter.com/streaming/reference/get/statuses/firehose</a>
  995. </p>
  996. <h3 id="StreamService.Sample">func (*StreamService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=1993:2070#L58">Sample</a></h3>
  997. <pre>func (srv *<a href="index.html#StreamService">StreamService</a>) Sample(params *<a href="index.html#StreamSampleParams">StreamSampleParams</a>) (*<a href="index.html#Stream">Stream</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  998. <p>
  999. Sample returns a small sample of public stream messages.
  1000. <a href="https://dev.twitter.com/streaming/reference/get/statuses/sample">https://dev.twitter.com/streaming/reference/get/statuses/sample</a>
  1001. </p>
  1002. <h3 id="StreamService.Site">func (*StreamService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=3630:3703#L100">Site</a></h3>
  1003. <pre>func (srv *<a href="index.html#StreamService">StreamService</a>) Site(params *<a href="index.html#StreamSiteParams">StreamSiteParams</a>) (*<a href="index.html#Stream">Stream</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  1004. <p>
  1005. Site returns messages for a set of users.
  1006. Requires special permission to access.
  1007. <a href="https://dev.twitter.com/streaming/reference/get/site">https://dev.twitter.com/streaming/reference/get/site</a>
  1008. </p>
  1009. <h3 id="StreamService.User">func (*StreamService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=2837:2910#L79">User</a></h3>
  1010. <pre>func (srv *<a href="index.html#StreamService">StreamService</a>) User(params *<a href="index.html#StreamUserParams">StreamUserParams</a>) (*<a href="index.html#Stream">Stream</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  1011. <p>
  1012. User returns a stream of messages specific to the authenticated User.
  1013. <a href="https://dev.twitter.com/streaming/reference/get/user">https://dev.twitter.com/streaming/reference/get/user</a>
  1014. </p>
  1015. <h2 id="StreamSiteParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=3132:3485#L88">StreamSiteParams</a></h2>
  1016. <pre>type StreamSiteParams struct {
  1017. FilterLevel <a href="../../../../builtin/index.html#string">string</a> `url:&#34;filter_level,omitempty&#34;`
  1018. Follow []<a href="../../../../builtin/index.html#string">string</a> `url:&#34;follow,omitempty,comma&#34;`
  1019. Language []<a href="../../../../builtin/index.html#string">string</a> `url:&#34;language,omitempty,comma&#34;`
  1020. Replies <a href="../../../../builtin/index.html#string">string</a> `url:&#34;replies,omitempty&#34;`
  1021. StallWarnings *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;stall_warnings,omitempty&#34;`
  1022. With <a href="../../../../builtin/index.html#string">string</a> `url:&#34;with,omitempty&#34;`
  1023. }</pre>
  1024. <p>
  1025. StreamSiteParams are the parameters for StreamService.Site.
  1026. </p>
  1027. <h2 id="StreamUserParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/streams.go?s=2296:2706#L67">StreamUserParams</a></h2>
  1028. <pre>type StreamUserParams struct {
  1029. FilterLevel <a href="../../../../builtin/index.html#string">string</a> `url:&#34;filter_level,omitempty&#34;`
  1030. Language []<a href="../../../../builtin/index.html#string">string</a> `url:&#34;language,omitempty,comma&#34;`
  1031. Locations []<a href="../../../../builtin/index.html#string">string</a> `url:&#34;locations,omitempty,comma&#34;`
  1032. Replies <a href="../../../../builtin/index.html#string">string</a> `url:&#34;replies,omitempty&#34;`
  1033. StallWarnings *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;stall_warnings,omitempty&#34;`
  1034. Track []<a href="../../../../builtin/index.html#string">string</a> `url:&#34;track,omitempty,comma&#34;`
  1035. With <a href="../../../../builtin/index.html#string">string</a> `url:&#34;with,omitempty&#34;`
  1036. }</pre>
  1037. <p>
  1038. StreamUserParams are the parameters for StreamService.User.
  1039. </p>
  1040. <h2 id="SwitchDemux">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/demux.go?s=382:1018#L3">SwitchDemux</a></h2>
  1041. <pre>type SwitchDemux struct {
  1042. All func(message interface{})
  1043. Tweet func(tweet *<a href="index.html#Tweet">Tweet</a>)
  1044. DM func(dm *<a href="index.html#DirectMessage">DirectMessage</a>)
  1045. StatusDeletion func(deletion *<a href="index.html#StatusDeletion">StatusDeletion</a>)
  1046. LocationDeletion func(LocationDeletion *<a href="index.html#LocationDeletion">LocationDeletion</a>)
  1047. StreamLimit func(limit *<a href="index.html#StreamLimit">StreamLimit</a>)
  1048. StatusWithheld func(statusWithheld *<a href="index.html#StatusWithheld">StatusWithheld</a>)
  1049. UserWithheld func(userWithheld *<a href="index.html#UserWithheld">UserWithheld</a>)
  1050. StreamDisconnect func(disconnect *<a href="index.html#StreamDisconnect">StreamDisconnect</a>)
  1051. Warning func(warning *<a href="index.html#StallWarning">StallWarning</a>)
  1052. FriendsList func(friendsList *<a href="index.html#FriendsList">FriendsList</a>)
  1053. Event func(event *<a href="index.html#Event">Event</a>)
  1054. Other func(message interface{})
  1055. }</pre>
  1056. <p>
  1057. SwitchDemux receives messages and uses a type switch to send each typed
  1058. message to a handler function.
  1059. </p>
  1060. <h3 id="NewSwitchDemux">func <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/demux.go?s=1096:1129#L20">NewSwitchDemux</a></h3>
  1061. <pre>func NewSwitchDemux() <a href="index.html#SwitchDemux">SwitchDemux</a></pre>
  1062. <p>
  1063. NewSwitchDemux returns a new SwitchMux which has NoOp handler functions.
  1064. </p>
  1065. <h3 id="SwitchDemux.Handle">func (SwitchDemux) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/demux.go?s=2066:2114#L41">Handle</a></h3>
  1066. <pre>func (d <a href="index.html#SwitchDemux">SwitchDemux</a>) Handle(message interface{})</pre>
  1067. <p>
  1068. Handle determines the type of a message and calls the corresponding receiver
  1069. function with the typed message. All messages are passed to the All func.
  1070. Messages with unmatched types are passed to the Other func.
  1071. </p>
  1072. <h3 id="SwitchDemux.HandleChan">func (SwitchDemux) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/demux.go?s=2855:2915#L74">HandleChan</a></h3>
  1073. <pre>func (d <a href="index.html#SwitchDemux">SwitchDemux</a>) HandleChan(messages &lt;-chan interface{})</pre>
  1074. <p>
  1075. HandleChan receives messages and calls the corresponding receiver function
  1076. with the typed message. All messages are passed to the All func. Messages
  1077. with unmatched type are passed to the Other func.
  1078. </p>
  1079. <h2 id="TimelineService">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/timelines.go?s=163:214#L1">TimelineService</a></h2>
  1080. <pre>type TimelineService struct {
  1081. <span class="comment">// contains filtered or unexported fields</span>
  1082. }</pre>
  1083. <p>
  1084. TimelineService provides methods for accessing Twitter status timeline
  1085. API endpoints.
  1086. </p>
  1087. <h3 id="TimelineService.HomeTimeline">func (*TimelineService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/timelines.go?s=2158:2257#L49">HomeTimeline</a></h3>
  1088. <pre>func (s *<a href="index.html#TimelineService">TimelineService</a>) HomeTimeline(params *<a href="index.html#HomeTimelineParams">HomeTimelineParams</a>) ([]<a href="index.html#Tweet">Tweet</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  1089. <p>
  1090. HomeTimeline returns recent Tweets and retweets from the user and those
  1091. users they follow.
  1092. Requires a user auth context.
  1093. <a href="https://dev.twitter.com/rest/reference/get/statuses/home_timeline">https://dev.twitter.com/rest/reference/get/statuses/home_timeline</a>
  1094. </p>
  1095. <h3 id="TimelineService.MentionTimeline">func (*TimelineService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/timelines.go?s=3102:3207#L69">MentionTimeline</a></h3>
  1096. <pre>func (s *<a href="index.html#TimelineService">TimelineService</a>) MentionTimeline(params *<a href="index.html#MentionTimelineParams">MentionTimelineParams</a>) ([]<a href="index.html#Tweet">Tweet</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  1097. <p>
  1098. MentionTimeline returns recent Tweet mentions of the authenticated user.
  1099. Requires a user auth context.
  1100. <a href="https://dev.twitter.com/rest/reference/get/statuses/mentions_timeline">https://dev.twitter.com/rest/reference/get/statuses/mentions_timeline</a>
  1101. </p>
  1102. <h3 id="TimelineService.RetweetsOfMeTimeline">func (*TimelineService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/timelines.go?s=4113:4228#L91">RetweetsOfMeTimeline</a></h3>
  1103. <pre>func (s *<a href="index.html#TimelineService">TimelineService</a>) RetweetsOfMeTimeline(params *<a href="index.html#RetweetsOfMeTimelineParams">RetweetsOfMeTimelineParams</a>) ([]<a href="index.html#Tweet">Tweet</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  1104. <p>
  1105. RetweetsOfMeTimeline returns the most recent Tweets by the authenticated
  1106. user that have been retweeted by others.
  1107. Requires a user auth context.
  1108. <a href="https://dev.twitter.com/rest/reference/get/statuses/retweets_of_me">https://dev.twitter.com/rest/reference/get/statuses/retweets_of_me</a>
  1109. </p>
  1110. <h3 id="TimelineService.UserTimeline">func (*TimelineService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/timelines.go?s=1146:1245#L27">UserTimeline</a></h3>
  1111. <pre>func (s *<a href="index.html#TimelineService">TimelineService</a>) UserTimeline(params *<a href="index.html#UserTimelineParams">UserTimelineParams</a>) ([]<a href="index.html#Tweet">Tweet</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  1112. <p>
  1113. UserTimeline returns recent Tweets from the specified user.
  1114. <a href="https://dev.twitter.com/rest/reference/get/statuses/user_timeline">https://dev.twitter.com/rest/reference/get/statuses/user_timeline</a>
  1115. </p>
  1116. <h2 id="Tweet">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=252:2516#L3">Tweet</a></h2>
  1117. <pre>type Tweet struct {
  1118. Contributors []<a href="index.html#Contributor">Contributor</a> `json:&#34;contributors&#34;`
  1119. Coordinates *<a href="index.html#Coordinates">Coordinates</a> `json:&#34;coordinates&#34;`
  1120. CreatedAt <a href="../../../../builtin/index.html#string">string</a> `json:&#34;created_at&#34;`
  1121. CurrentUserRetweet *<a href="index.html#TweetIdentifier">TweetIdentifier</a> `json:&#34;current_user_retweet&#34;`
  1122. Entities *<a href="index.html#Entities">Entities</a> `json:&#34;entities&#34;`
  1123. FavoriteCount <a href="../../../../builtin/index.html#int">int</a> `json:&#34;favorite_count&#34;`
  1124. Favorited <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;favorited&#34;`
  1125. FilterLevel <a href="../../../../builtin/index.html#string">string</a> `json:&#34;filter_level&#34;`
  1126. ID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;id&#34;`
  1127. IDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;id_str&#34;`
  1128. InReplyToScreenName <a href="../../../../builtin/index.html#string">string</a> `json:&#34;in_reply_to_screen_name&#34;`
  1129. InReplyToStatusID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;in_reply_to_status_id&#34;`
  1130. InReplyToStatusIDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;in_reply_to_status_id_str&#34;`
  1131. InReplyToUserID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;in_reply_to_user_id&#34;`
  1132. InReplyToUserIDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;in_reply_to_user_id_str&#34;`
  1133. Lang <a href="../../../../builtin/index.html#string">string</a> `json:&#34;lang&#34;`
  1134. PossiblySensitive <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;possibly_sensitive&#34;`
  1135. RetweetCount <a href="../../../../builtin/index.html#int">int</a> `json:&#34;retweet_count&#34;`
  1136. Retweeted <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;retweeted&#34;`
  1137. RetweetedStatus *<a href="index.html#Tweet">Tweet</a> `json:&#34;retweeted_status&#34;`
  1138. Source <a href="../../../../builtin/index.html#string">string</a> `json:&#34;source&#34;`
  1139. Scopes map[<a href="../../../../builtin/index.html#string">string</a>]interface{} `json:&#34;scopes&#34;`
  1140. Text <a href="../../../../builtin/index.html#string">string</a> `json:&#34;text&#34;`
  1141. Place *<a href="index.html#Place">Place</a> `json:&#34;place&#34;`
  1142. Truncated <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;truncated&#34;`
  1143. User *<a href="index.html#User">User</a> `json:&#34;user&#34;`
  1144. WithheldCopyright <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;withheld_copyright&#34;`
  1145. WithheldInCountries []<a href="../../../../builtin/index.html#string">string</a> `json:&#34;withheld_in_countries&#34;`
  1146. WithheldScope <a href="../../../../builtin/index.html#string">string</a> `json:&#34;withheld_scope&#34;`
  1147. ExtendedEntities *<a href="index.html#ExtendedEntity">ExtendedEntity</a> `json:&#34;extended_entities&#34;`
  1148. QuotedStatusID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;quoted_status_id&#34;`
  1149. QuotedStatusIDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;quoted_status_id_str&#34;`
  1150. QuotedStatus *<a href="index.html#Tweet">Tweet</a> `json:&#34;quoted_status&#34;`
  1151. }</pre>
  1152. <p>
  1153. Tweet represents a Twitter Tweet, previously called a status.
  1154. <a href="https://dev.twitter.com/overview/api/tweets">https://dev.twitter.com/overview/api/tweets</a>
  1155. Unused or deprecated fields not provided: Geo, Annotations
  1156. </p>
  1157. <h2 id="TweetIdentifier">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/statuses.go?s=3872:3959#L76">TweetIdentifier</a></h2>
  1158. <pre>type TweetIdentifier struct {
  1159. ID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;id&#34;`
  1160. IDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;id_str&#34;`
  1161. }</pre>
  1162. <p>
  1163. TweetIdentifier represents the id by which a Tweet can be identified.
  1164. </p>
  1165. <h2 id="URLEntity">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/entities.go?s=609:791#L10">URLEntity</a></h2>
  1166. <pre>type URLEntity struct {
  1167. Indices <a href="index.html#Indices">Indices</a> `json:&#34;indices&#34;`
  1168. DisplayURL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;display_url&#34;`
  1169. ExpandedURL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;expanded_url&#34;`
  1170. URL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;url&#34;`
  1171. }</pre>
  1172. <p>
  1173. URLEntity represents a URL which has been parsed from text.
  1174. </p>
  1175. <h2 id="User">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/users.go?s=152:3282#L1">User</a></h2>
  1176. <pre>type User struct {
  1177. ContributorsEnabled <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;contributors_enabled&#34;`
  1178. CreatedAt <a href="../../../../builtin/index.html#string">string</a> `json:&#34;created_at&#34;`
  1179. DefaultProfile <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;default_profile&#34;`
  1180. DefaultProfileImage <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;default_profile_image&#34;`
  1181. Description <a href="../../../../builtin/index.html#string">string</a> `json:&#34;description&#34;`
  1182. Email <a href="../../../../builtin/index.html#string">string</a> `json:&#34;email&#34;`
  1183. Entities *<a href="index.html#UserEntities">UserEntities</a> `json:&#34;entities&#34;`
  1184. FavouritesCount <a href="../../../../builtin/index.html#int">int</a> `json:&#34;favourites_count&#34;`
  1185. FollowRequestSent <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;follow_request_sent&#34;`
  1186. Following <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;following&#34;`
  1187. FollowersCount <a href="../../../../builtin/index.html#int">int</a> `json:&#34;followers_count&#34;`
  1188. FriendsCount <a href="../../../../builtin/index.html#int">int</a> `json:&#34;friends_count&#34;`
  1189. GeoEnabled <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;geo_enabled&#34;`
  1190. ID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;id&#34;`
  1191. IDStr <a href="../../../../builtin/index.html#string">string</a> `json:&#34;id_str&#34;`
  1192. IsTranslator <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;id_translator&#34;`
  1193. Lang <a href="../../../../builtin/index.html#string">string</a> `json:&#34;lang&#34;`
  1194. ListedCount <a href="../../../../builtin/index.html#int">int</a> `json:&#34;listed_count&#34;`
  1195. Location <a href="../../../../builtin/index.html#string">string</a> `json:&#34;location&#34;`
  1196. Name <a href="../../../../builtin/index.html#string">string</a> `json:&#34;name&#34;`
  1197. Notifications <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;notifications&#34;`
  1198. ProfileBackgroundColor <a href="../../../../builtin/index.html#string">string</a> `json:&#34;profile_background_color&#34;`
  1199. ProfileBackgroundImageURL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;profile_background_image_url&#34;`
  1200. ProfileBackgroundImageURLHttps <a href="../../../../builtin/index.html#string">string</a> `json:&#34;profile_background_image_url_https&#34;`
  1201. ProfileBackgroundTile <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;profile_background_tile&#34;`
  1202. ProfileBannerURL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;profile_banner_url&#34;`
  1203. ProfileImageURL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;profile_image_url&#34;`
  1204. ProfileImageURLHttps <a href="../../../../builtin/index.html#string">string</a> `json:&#34;profile_image_url_https&#34;`
  1205. ProfileLinkColor <a href="../../../../builtin/index.html#string">string</a> `json:&#34;profile_link_color&#34;`
  1206. ProfileSidebarBorderColor <a href="../../../../builtin/index.html#string">string</a> `json:&#34;profile_sidebar_border_color&#34;`
  1207. ProfileSidebarFillColor <a href="../../../../builtin/index.html#string">string</a> `json:&#34;profile_sidebar_fill_color&#34;`
  1208. ProfileTextColor <a href="../../../../builtin/index.html#string">string</a> `json:&#34;profile_text_color&#34;`
  1209. ProfileUseBackgroundImage <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;profile_use_background_image&#34;`
  1210. Protected <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;protected&#34;`
  1211. ScreenName <a href="../../../../builtin/index.html#string">string</a> `json:&#34;screen_name&#34;`
  1212. ShowAllInlineMedia <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;show_all_inline_media&#34;`
  1213. Status *<a href="index.html#Tweet">Tweet</a> `json:&#34;status&#34;`
  1214. StatusesCount <a href="../../../../builtin/index.html#int">int</a> `json:&#34;statuses_count&#34;`
  1215. Timezone <a href="../../../../builtin/index.html#string">string</a> `json:&#34;time_zone&#34;`
  1216. URL <a href="../../../../builtin/index.html#string">string</a> `json:&#34;url&#34;`
  1217. UtcOffset <a href="../../../../builtin/index.html#int">int</a> `json:&#34;utc_offset&#34;`
  1218. Verified <a href="../../../../builtin/index.html#bool">bool</a> `json:&#34;verified&#34;`
  1219. WithheldInCountries <a href="../../../../builtin/index.html#string">string</a> `json:&#34;withheld_in_countries&#34;`
  1220. WithholdScope <a href="../../../../builtin/index.html#string">string</a> `json:&#34;withheld_scope&#34;`
  1221. }</pre>
  1222. <p>
  1223. User represents a Twitter User.
  1224. <a href="https://dev.twitter.com/overview/api/users">https://dev.twitter.com/overview/api/users</a>
  1225. </p>
  1226. <h2 id="UserEntities">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/entities.go?s=1673:1779#L41">UserEntities</a></h2>
  1227. <pre>type UserEntities struct {
  1228. URL <a href="index.html#Entities">Entities</a> `json:&#34;url&#34;`
  1229. Description <a href="index.html#Entities">Entities</a> `json:&#34;description&#34;`
  1230. }</pre>
  1231. <p>
  1232. UserEntities contain Entities parsed from User url and description fields.
  1233. <a href="https://dev.twitter.com/overview/api/entities-in-twitter-objects#users">https://dev.twitter.com/overview/api/entities-in-twitter-objects#users</a>
  1234. </p>
  1235. <h2 id="UserLookupParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/users.go?s=4292:4549#L77">UserLookupParams</a></h2>
  1236. <pre>type UserLookupParams struct {
  1237. UserID []<a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;user_id,omitempty,comma&#34;`
  1238. ScreenName []<a href="../../../../builtin/index.html#string">string</a> `url:&#34;screen_name,omitempty,comma&#34;`
  1239. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;` <span class="comment">// whether &#39;status&#39; should include entities</span>
  1240. }</pre>
  1241. <p>
  1242. UserLookupParams are the parameters for UserService.Lookup.
  1243. </p>
  1244. <h2 id="UserSearchParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/users.go?s=5008:5305#L93">UserSearchParams</a></h2>
  1245. <pre>type UserSearchParams struct {
  1246. Query <a href="../../../../builtin/index.html#string">string</a> `url:&#34;q,omitempty&#34;`
  1247. Page <a href="../../../../builtin/index.html#int">int</a> `url:&#34;page,omitempty&#34;` <span class="comment">// 1-based page number</span>
  1248. Count <a href="../../../../builtin/index.html#int">int</a> `url:&#34;count,omitempty&#34;`
  1249. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;` <span class="comment">// whether &#39;status&#39; should include entities</span>
  1250. }</pre>
  1251. <p>
  1252. UserSearchParams are the parameters for UserService.Search.
  1253. </p>
  1254. <h2 id="UserService">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/users.go?s=3358:3405#L49">UserService</a></h2>
  1255. <pre>type UserService struct {
  1256. <span class="comment">// contains filtered or unexported fields</span>
  1257. }</pre>
  1258. <p>
  1259. UserService provides methods for accessing Twitter user API endpoints.
  1260. </p>
  1261. <h3 id="UserService.Lookup">func (*UserService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/users.go?s=4660:4746#L85">Lookup</a></h3>
  1262. <pre>func (s *<a href="index.html#UserService">UserService</a>) Lookup(params *<a href="index.html#UserLookupParams">UserLookupParams</a>) ([]<a href="index.html#User">User</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  1263. <p>
  1264. Lookup returns the requested Users as a slice.
  1265. <a href="https://dev.twitter.com/rest/reference/get/users/lookup">https://dev.twitter.com/rest/reference/get/users/lookup</a>
  1266. </p>
  1267. <h3 id="UserService.Search">func (*UserService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/users.go?s=5439:5539#L103">Search</a></h3>
  1268. <pre>func (s *<a href="index.html#UserService">UserService</a>) Search(query <a href="../../../../builtin/index.html#string">string</a>, params *<a href="index.html#UserSearchParams">UserSearchParams</a>) ([]<a href="index.html#User">User</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  1269. <p>
  1270. Search queries public user accounts.
  1271. Requires a user auth context.
  1272. <a href="https://dev.twitter.com/rest/reference/get/users/search">https://dev.twitter.com/rest/reference/get/users/search</a>
  1273. </p>
  1274. <h3 id="UserService.Show">func (*UserService) <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/users.go?s=3957:4038#L69">Show</a></h3>
  1275. <pre>func (s *<a href="index.html#UserService">UserService</a>) Show(params *<a href="index.html#UserShowParams">UserShowParams</a>) (*<a href="index.html#User">User</a>, *<a href="../../../../net/http/index.html">http</a>.<a href="../../../../net/http/index.html#Response">Response</a>, <a href="../../../../builtin/index.html#error">error</a>)</pre>
  1276. <p>
  1277. Show returns the requested User.
  1278. <a href="https://dev.twitter.com/rest/reference/get/users/show">https://dev.twitter.com/rest/reference/get/users/show</a>
  1279. </p>
  1280. <h2 id="UserShowParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/users.go?s=3625:3862#L61">UserShowParams</a></h2>
  1281. <pre>type UserShowParams struct {
  1282. UserID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;user_id,omitempty&#34;`
  1283. ScreenName <a href="../../../../builtin/index.html#string">string</a> `url:&#34;screen_name,omitempty&#34;`
  1284. IncludeEntities *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_entities,omitempty&#34;` <span class="comment">// whether &#39;status&#39; should include entities</span>
  1285. }</pre>
  1286. <p>
  1287. UserShowParams are the parameters for UserService.Show.
  1288. </p>
  1289. <h2 id="UserTimelineParams">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/timelines.go?s=473:1012#L13">UserTimelineParams</a></h2>
  1290. <pre>type UserTimelineParams struct {
  1291. UserID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;user_id,omitempty&#34;`
  1292. ScreenName <a href="../../../../builtin/index.html#string">string</a> `url:&#34;screen_name,omitempty&#34;`
  1293. Count <a href="../../../../builtin/index.html#int">int</a> `url:&#34;count,omitempty&#34;`
  1294. SinceID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;since_id,omitempty&#34;`
  1295. MaxID <a href="../../../../builtin/index.html#int64">int64</a> `url:&#34;max_id,omitempty&#34;`
  1296. TrimUser *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;trim_user,omitempty&#34;`
  1297. ExcludeReplies *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;exclude_replies,omitempty&#34;`
  1298. ContributorDetails *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;contributor_details,omitempty&#34;`
  1299. IncludeRetweets *<a href="../../../../builtin/index.html#bool">bool</a> `url:&#34;include_rts,omitempty&#34;`
  1300. }</pre>
  1301. <p>
  1302. UserTimelineParams are the parameters for TimelineService.UserTimeline.
  1303. </p>
  1304. <h2 id="UserWithheld">type <a href="http://localhost:6060/src/github.com/dghubble/go-twitter/twitter/stream_messages.go?s=1971:2102#L49">UserWithheld</a></h2>
  1305. <pre>type UserWithheld struct {
  1306. ID <a href="../../../../builtin/index.html#int64">int64</a> `json:&#34;id&#34;`
  1307. WithheldInCountries []<a href="../../../../builtin/index.html#string">string</a> `json:&#34;withheld_in_countries&#34;`
  1308. }</pre>
  1309. <p>
  1310. UserWithheld indicates a User with the given ID has been withheld in
  1311. certain countries.
  1312. <a href="https://dev.twitter.com/streaming/overview/messages-types#withheld_content_notices">https://dev.twitter.com/streaming/overview/messages-types#withheld_content_notices</a>
  1313. </p>
  1314. <div id="footer">
  1315. Build version go1.6.<br>
  1316. Except as <a href="https://developers.google.com/site-policies#restrictions">noted</a>,
  1317. the content of this page is licensed under the
  1318. Creative Commons Attribution 3.0 License,
  1319. and code is licensed under a <a href="http://localhost:6060/LICENSE">BSD license</a>.<br>
  1320. <a href="http://localhost:6060/doc/tos.html">Terms of Service</a> |
  1321. <a href="http://www.google.com/intl/en/policies/privacy/">Privacy Policy</a>
  1322. </div>
  1323. </div><!-- .container -->
  1324. </div><!-- #page -->
  1325. <!-- TODO(adonovan): load these from <head> using "defer" attribute? -->
  1326. <script type="text/javascript" src="../../../../../lib/godoc/jquery.js"></script>
  1327. <script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.js"></script>
  1328. <script type="text/javascript" src="../../../../../lib/godoc/jquery.treeview.edit.js"></script>
  1329. <script type="text/javascript" src="../../../../../lib/godoc/godocs.js"></script>
  1330. </body>
  1331. </html>