Skip to content

Instantly share code, notes, and snippets.

@jpsim

jpsim/QueryKit.QuerySet.xml Secret

Last active August 29, 2015 14:06
Show Gist options
  • Save jpsim/377cd14e74c7c338d77e to your computer and use it in GitHub Desktop.
Save jpsim/377cd14e74c7c338d77e to your computer and use it in GitHub Desktop.
Download ZIP
SourceKitten Doc Output
Raw
QueryKit.QuerySet.xml
<jazzy>
<Function column="24" file="/Users/jp/Projects/QueryKit/QueryKit/Attribute.swift" line="19">
<Name>init(attributes:)</Name>
<USR>s:FC8QueryKit9AttributecU__FMGS0_Q__FT10attributesGSaSS__GS0_Q__</USR>
<Declaration>public convenience convenience init(attributes: Array&lt;String&gt;)</Declaration>
<Abstract>
<Para>Builds a compound attribute with other key paths</Para>
</Abstract>
</Function>
<Function column="20" file="/Users/jp/Projects/QueryKit/QueryKit/Attribute.swift" line="68">
<Name>!(_:)</Name>
<USR>s:F8QueryKitop1nFGCS_9AttributeSb_CSo11NSPredicate</USR>
<Declaration>prefix public func !(left: Attribute&lt;Bool&gt;) -&gt; NSPredicate</Declaration>
<Abstract>
<Para>MARK: Bool Attributes</Para>
</Abstract>
</Function>
<Class column="14" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="14">
<Name>QuerySet</Name>
<USR>s:C8QueryKit8QuerySet</USR>
<Declaration>public class QuerySet&lt;T : NSManagedObject&gt; : SequenceType, Equatable</Declaration>
<Abstract>
<Para>Represents a lazy database lookup for a set of objects.</Para>
</Abstract>
</Class>
<Other column="16" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="16">
<Name>context</Name>
<USR>s:vC8QueryKit8QuerySet7contextCSo22NSManagedObjectContext</USR>
<Declaration>public let context: NSManagedObjectContext</Declaration>
<Abstract>
<Para>Returns the managed object context that will be used to execute any requests.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="19">
<Name>entityName</Name>
<USR>s:vC8QueryKit8QuerySet10entityNameSS</USR>
<Declaration>public let entityName: String</Declaration>
<Abstract>
<Para>Returns the name of the entity the request is configured to fetch.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="22">
<Name>sortDescriptors</Name>
<USR>s:vC8QueryKit8QuerySet15sortDescriptorsGSaCSo16NSSortDescriptor_</USR>
<Declaration>public let sortDescriptors: [(NSSortDescriptor)]</Declaration>
<Abstract>
<Para>Returns the sort descriptors of the receiver.</Para>
</Abstract>
</Other>
<Other column="16" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="25">
<Name>predicate</Name>
<USR>s:vC8QueryKit8QuerySet9predicateGSqCSo11NSPredicate_</USR>
<Declaration>public let predicate: NSPredicate?</Declaration>
<Abstract>
<Para>Returns the predicate of the receiver.</Para>
</Abstract>
</Other>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="51">
<Name>orderBy(_:)</Name>
<USR>s:FC8QueryKit8QuerySet7orderByU__FGS0_Q__FCSo16NSSortDescriptorGS0_Q__</USR>
<Declaration>public func orderBy(sortDescriptor: NSSortDescriptor) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects ordered by the given sort descriptor.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="56">
<Name>orderBy(_:)</Name>
<USR>s:FC8QueryKit8QuerySet7orderByU__FGS0_Q__FGSaCSo16NSSortDescriptor_GS0_Q__</USR>
<Declaration>public func orderBy(sortDescriptors: [NSSortDescriptor]) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects ordered by the given sort descriptors.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="61">
<Name>reverse()</Name>
<USR>s:FC8QueryKit8QuerySet7reverseU__FGS0_Q__FT_GS0_Q__</USR>
<Declaration>public func reverse() -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Reverses the ordering of the QuerySet</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="68">
<Name>filter(_:)</Name>
<USR>s:FC8QueryKit8QuerySet6filterU__FGS0_Q__FCSo11NSPredicateGS0_Q__</USR>
<Declaration>public func filter(predicate: NSPredicate) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects that match the given predicate.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="79">
<Name>filter(_:)</Name>
<USR>s:FC8QueryKit8QuerySet6filterU__FGS0_Q__FGSaCSo11NSPredicate_GS0_Q__</USR>
<Declaration>public func filter(predicates: [NSPredicate]) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects that match the given predicates.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="85">
<Name>exclude(_:)</Name>
<USR>s:FC8QueryKit8QuerySet7excludeU__FGS0_Q__FCSo11NSPredicateGS0_Q__</USR>
<Declaration>public func exclude(predicate: NSPredicate) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects that exclude the given predicate.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="91">
<Name>exclude(_:)</Name>
<USR>s:FC8QueryKit8QuerySet7excludeU__FGS0_Q__FGSaCSo11NSPredicate_GS0_Q__</USR>
<Declaration>public func exclude(predicates: [NSPredicate]) -&gt; QuerySet&lt;T&gt;</Declaration>
<Abstract>
<Para>Returns a new QuerySet containing objects that exclude the given predicates.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="171">
<Name>count()</Name>
<USR>s:FC8QueryKit8QuerySet5countU__FGS0_Q__FT_GSqSi_</USR>
<Declaration>public func count() -&gt; Int?</Declaration>
<Abstract>
<Para>Returns the count of objects matching the QuerySet.</Para>
</Abstract>
</Function>
<Function column="17" file="/Users/jp/Projects/QueryKit/QueryKit/QuerySet.swift" line="193">
<Name>delete()</Name>
<USR>s:FC8QueryKit8QuerySet6deleteU__FGS0_Q__FT_T5countSi5errorGSqCSo7NSError__</USR>
<Declaration>public func delete() -&gt; (count: Int, error: NSError?)</Declaration>
<Abstract>
<Para>Deletes all the objects matching the QuerySet.</Para>
</Abstract>
</Function>
</jazzy>
Raw
Swifter.xml
<jazzy>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFavorites.swift" line="37">
<Name>getFavoritesListWithCount(_:sinceID:maxID:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter25getFavoritesListWithCountFS0_FTGSqSi_7sinceIDGSqSi_5maxIDGSqSi_7successGSqFT8statusesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getFavoritesListWithCount(count: Int?, sinceID: Int?, maxID: Int?, success: ((statuses: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET favorites/list</Para>
</Abstract>
<Discussion>
<Para>Returns the 20 most recent Tweets favorited by the authenticating or specified user.</Para>
<Para>If you do not provide either a user_id or screen_name to this method, it will assume you are requesting on behalf of the authenticating user. Specify one or the other for best results.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFavorites.swift" line="117">
<Name>postDestroyFavoriteWithID(_:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter25postDestroyFavoriteWithIDFS0_FTSi15includeEntitiesGSqSb_7successGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postDestroyFavoriteWithID(id: Int, includeEntities: Bool?, success: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST favorites/destroy</Para>
</Abstract>
<Discussion>
<Para>Un-favorites the status specified in the ID parameter as the authenticating user. Returns the un-favorited status in the requested format when successful.</Para>
<Para>This process invoked by this method is asynchronous. The immediately returned status may not indicate the resultant favorited status of the tweet. A 200 OK response from this method will indicate whether the intended action was successful or not.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFavorites.swift" line="143">
<Name>postCreateFavoriteWithID(_:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter24postCreateFavoriteWithIDFS0_FTSi15includeEntitiesGSqSb_7successGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postCreateFavoriteWithID(id: Int, includeEntities: Bool?, success: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: SwifterHTTPRequest.FailureHandler?)</Declaration>
<Abstract>
<Para>POST favorites/create</Para>
</Abstract>
<Discussion>
<Para>Favorites the status specified in the ID parameter as the authenticating user. Returns the favorite status when successful.</Para>
<Para>This process invoked by this method is asynchronous. The immediately returned status may not indicate the resultant favorited status of the tweet. A 200 OK response from this method will indicate whether the intended action was successful or not.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterSuggested.swift" line="37">
<Name>getUsersSuggestionsWithSlug(_:lang:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter27getUsersSuggestionsWithSlugFS0_FTSS4langGSqSS_7successGSqFT5usersGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getUsersSuggestionsWithSlug(slug: String, lang: String?, success: ((users: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET users/suggestions/:slug</Para>
</Abstract>
<Discussion>
<Para>Access the users in a given category of the Twitter suggested user list.</Para>
<Para>It is recommended that applications cache this data for no more than one hour.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterSuggested.swift" line="59">
<Name>getUsersSuggestionsWithLang(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter27getUsersSuggestionsWithLangFS0_FTGSqSS_7successGSqFT5usersGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getUsersSuggestionsWithLang(lang: String?, success: ((users: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET users/suggestions</Para>
</Abstract>
<Discussion>
<Para>Access to Twitter's suggested user list. This returns the list of suggested user categories. The category can be used in GET users/suggestions/:slug to get the users in that category.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterSuggested.swift" line="81">
<Name>getUsersSuggestionsForSlugMembers(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter33getUsersSuggestionsForSlugMembersFS0_FTSS7successGSqFT5usersGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getUsersSuggestionsForSlugMembers(slug: String, success: ((users: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET users/suggestions/:slug/members</Para>
</Abstract>
<Discussion>
<Para>Access the users in a given category of the Twitter suggested user list and return their most recent status if they are not a protected user.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterStreaming.swift" line="41">
<Name>postStatusesFilterWithFollow(_:track:locations:delimited:stallWarnings:progress:stallWarningHandler:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter28postStatusesFilterWithFollowFS0_FTGSqGSaSS__5trackGSqGSaSS__9locationsGSqGSaSS__9delimitedGSqSb_13stallWarningsGSqSb_8progressGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__19stallWarningHandlerGSqFT4codeGSqSS_7messageGSqSS_11percentFullGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postStatusesFilterWithFollow(follow: [String]?, track: [String]?, locations: [String]?, delimited: Bool?, stallWarnings: Bool?, progress: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, stallWarningHandler: ((code: String?, message: String?, percentFull: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST statuses/filter</Para>
</Abstract>
<Discussion>
<Para>Returns public statuses that match one or more filter predicates. Multiple parameters may be specified which allows most clients to use a single connection to the Streaming API. Both GET and POST requests are supported, but GET requests with too many parameters may cause the request to be rejected for excessive URL length. Use a POST request to avoid long URLs.</Para>
<Para>The track, follow, and locations fields should be considered to be combined with an OR operator. track=foo&amp;follow=1234 returns Tweets matching &quot;foo&quot; OR created by user 1234.</Para>
<Para>The default access level allows up to 400 track keywords, 5,000 follow userids and 25 0.1-360 degree location boxes. If you need elevated access to the Streaming API, you should explore our partner providers of Twitter data here: https://dev.twitter.com/programs/twitter-certified-products/products#Certified-Data-Products</Para>
<Para>At least one predicate parameter (follow, locations, or track) must be specified.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterStreaming.swift" line="92">
<Name>getStatusesSampleDelimited(_:stallWarnings:progress:stallWarningHandler:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter26getStatusesSampleDelimitedFS0_FTGSqSb_13stallWarningsGSqSb_8progressGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__19stallWarningHandlerGSqFT4codeGSqSS_7messageGSqSS_11percentFullGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getStatusesSampleDelimited(delimited: Bool?, stallWarnings: Bool?, progress: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, stallWarningHandler: ((code: String?, message: String?, percentFull: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET statuses/sample</Para>
</Abstract>
<Discussion>
<Para>Returns a small random sample of all public statuses. The Tweets returned by the default access level are the same, so if two different clients connect to this endpoint, they will see the same Tweets.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterStreaming.swift" line="134">
<Name>getStatusesFirehose(_:delimited:stallWarnings:progress:stallWarningHandler:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter19getStatusesFirehoseFS0_FTGSqSi_9delimitedGSqSb_13stallWarningsGSqSb_8progressGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__19stallWarningHandlerGSqFT4codeGSqSS_7messageGSqSS_11percentFullGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getStatusesFirehose(count: Int?, delimited: Bool?, stallWarnings: Bool?, progress: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, stallWarningHandler: ((code: String?, message: String?, percentFull: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET statuses/firehose</Para>
</Abstract>
<Discussion>
<Para>This endpoint requires special permission to access.</Para>
<Para>Returns all public statuses. Few applications require this level of access. Creative use of a combination of other resources and various access levels can satisfy nearly every application use case.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterStreaming.swift" line="177">
<Name>getUserStreamDelimited(_:stallWarnings:includeMessagesFromFollowedAccounts:includeReplies:track:locations:stringifyFriendIDs:progress:stallWarningHandler:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter22getUserStreamDelimitedFS0_FTGSqSb_13stallWarningsGSqSb_35includeMessagesFromFollowedAccountsGSqSb_14includeRepliesGSqSb_5trackGSqGSaSS__9locationsGSqGSaSS__18stringifyFriendIDsGSqSb_8progressGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__19stallWarningHandlerGSqFT4codeGSqSS_7messageGSqSS_11percentFullGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getUserStreamDelimited(delimited: Bool?, stallWarnings: Bool?, includeMessagesFromFollowedAccounts: Bool?, includeReplies: Bool?, track: [String]?, locations: [String]?, stringifyFriendIDs: Bool?, progress: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, stallWarningHandler: ((code: String?, message: String?, percentFull: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET user</Para>
</Abstract>
<Discussion>
<Para>Streams messages for a single user, as described in User streams https://dev.twitter.com/docs/streaming-apis/streams/user</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterStreaming.swift" line="236">
<Name>getSiteStreamDelimited(_:stallWarnings:restrictToUserMessages:includeReplies:stringifyFriendIDs:progress:stallWarningHandler:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter22getSiteStreamDelimitedFS0_FTGSqSb_13stallWarningsGSqSb_22restrictToUserMessagesGSqSb_14includeRepliesGSqSb_18stringifyFriendIDsGSqSb_8progressGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__19stallWarningHandlerGSqFT4codeGSqSS_7messageGSqSS_11percentFullGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getSiteStreamDelimited(delimited: Bool?, stallWarnings: Bool?, restrictToUserMessages: Bool?, includeReplies: Bool?, stringifyFriendIDs: Bool?, progress: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, stallWarningHandler: ((code: String?, message: String?, percentFull: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET site</Para>
</Abstract>
<Discussion>
<Para>Streams messages for a set of users, as described in Site streams https://dev.twitter.com/docs/streaming-apis/streams/site</Para>
</Discussion>
</Function>
<Class column="14" file="/Users/jp/Projects/Swifter/Swifter/Swifter.swift" line="30">
<Name>Swifter</Name>
<USR>s:C10SwifteriOS7Swifter</USR>
<Declaration>public class Swifter</Declaration>
<Abstract>
<Para>A very Swifty class</Para>
</Abstract>
</Class>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterSavedSearches.swift" line="35">
<Name>getSavedSearchesListWithSuccess(_:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter31getSavedSearchesListWithSuccessFS0_FTGSqFT13savedSearchesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getSavedSearchesListWithSuccess(success: ((savedSearches: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET saved_searches/list</Para>
</Abstract>
<Discussion>
<Para>Returns the authenticated user's saved search queries.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterSavedSearches.swift" line="52">
<Name>getSavedSearchesShowWithID(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter26getSavedSearchesShowWithIDFS0_FTSi7successGSqFT11savedSearchGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getSavedSearchesShowWithID(id: Int, success: ((savedSearch: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET saved_searches/show/:id</Para>
</Abstract>
<Discussion>
<Para>Retrieve the information for the saved search represented by the given id. The authenticating user must be the owner of saved search ID being requested.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterSavedSearches.swift" line="69">
<Name>postSavedSearchesCreateShowWithQuery(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter36postSavedSearchesCreateShowWithQueryFS0_FTSS7successGSqFT11savedSearchGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postSavedSearchesCreateShowWithQuery(query: String, success: ((savedSearch: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST saved_searches/create</Para>
</Abstract>
<Discussion>
<Para>Create a new saved search for the authenticated user. A user may only have 25 saved searches.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterSavedSearches.swift" line="89">
<Name>postSavedSearchesDestroyWithID(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter30postSavedSearchesDestroyWithIDFS0_FTSi7successGSqFT11savedSearchGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postSavedSearchesDestroyWithID(id: Int, success: ((savedSearch: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST saved_searches/destroy/:id</Para>
</Abstract>
<Discussion>
<Para>Destroys a saved search for the authenticating user. The authenticating user must be the owner of saved search id being destroyed.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTweets.swift" line="35">
<Name>getStatusesRetweetsWithID(_:count:trimUser:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter25getStatusesRetweetsWithIDFS0_FTSi5countGSqSi_8trimUserGSqSb_7successGSqFT8statusesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getStatusesRetweetsWithID(id: Int, count: Int?, trimUser: Bool?, success: ((statuses: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET statuses/retweets/:id</Para>
</Abstract>
<Discussion>
<Para>Returns up to 100 of the first retweets of a given tweet.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTweets.swift" line="74">
<Name>getStatusesShowWithID(_:count:trimUser:includeMyRetweet:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter21getStatusesShowWithIDFS0_FTSi5countGSqSi_8trimUserGSqSb_16includeMyRetweetGSqSb_15includeEntitiesGSqSb_7successGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getStatusesShowWithID(id: Int, count: Int?, trimUser: Bool?, includeMyRetweet: Bool?, includeEntities: Bool?, success: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET statuses/show/:id</Para>
</Abstract>
<Discussion>
<Para>Returns a single Tweet, specified by the id parameter. The Tweet's author will also be embedded within the tweet.</Para>
<Para>See Embeddable Timelines, Embeddable Tweets, and GET statuses/oembed for tools to render Tweets according to Display Requirements.</Para>
<Para># About Geo</Para>
<Para>If there is no geotag for a status, then there will be an empty &lt;geo/&gt; or &quot;geo&quot; : {}. This can only be populated if the user has used the Geotagging API to send a statuses/update.</Para>
<Para>The JSON response mostly uses conventions laid out in GeoJSON. Unfortunately, the coordinates that Twitter renders are reversed from the GeoJSON specification (GeoJSON specifies a longitude then a latitude, whereas we are currently representing it as a latitude then a longitude). Our JSON renders as: &quot;geo&quot;: { &quot;type&quot;:&quot;Point&quot;, &quot;coordinates&quot;:[37.78029, -122.39697] }</Para>
<Para># Contributors</Para>
<Para>If there are no contributors for a Tweet, then there will be an empty or &quot;contributors&quot; : {}. This field will only be populated if the user has contributors enabled on his or her account -- this is a beta feature that is not yet generally available to all.</Para>
<Para>This object contains an array of user IDs for users who have contributed to this status (an example of a status that has been contributed to is this one). In practice, there is usually only one ID in this array. The JSON renders as such &quot;contributors&quot;:[8285392].</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTweets.swift" line="105">
<Name>postStatusesDestroyWithID(_:trimUser:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter25postStatusesDestroyWithIDFS0_FTSi8trimUserGSqSb_7successGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postStatusesDestroyWithID(id: Int, trimUser: Bool?, success: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST statuses/destroy/:id</Para>
</Abstract>
<Discussion>
<Para>Destroys the status specified by the required ID parameter. The authenticating user must be the author of the specified status. Returns the destroyed status if successful.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTweets.swift" line="144">
<Name>postStatusUpdate(_:inReplyToStatusID:lat:long:placeID:displayCoordinates:trimUser:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter16postStatusUpdateFS0_FTSS17inReplyToStatusIDGSqSi_3latGSqSd_4longGSqSd_7placeIDGSqSd_18displayCoordinatesGSqSb_8trimUserGSqSb_7successGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postStatusUpdate(status: String, inReplyToStatusID: Int?, lat: Double?, long: Double?, placeID: Double?, displayCoordinates: Bool?, trimUser: Bool?, success: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST statuses/update</Para>
</Abstract>
<Discussion>
<Para>Updates the authenticating user's current status, also known as tweeting. To upload an image to accompany the tweet, use POST statuses/update_with_media.</Para>
<Para>For each update attempt, the update text is compared with the authenticating user's recent tweets. Any attempt that would result in duplication will be blocked, resulting in a 403 error. Therefore, a user cannot submit the same status twice in a row.</Para>
<Para>While not rate limited by the API a user is limited in the number of tweets they can create at a time. If the number of updates posted by the user reaches the current allowed limit this method will return an HTTP 403 error.</Para>
<Para>
<rawHTML/>
<rawHTML/>Any geo-tagging parameters in the update will be ignored if geo_enabled for the user is false (this is the default setting for all users unless the user has enabled geolocation in their settings)
<rawHTML>&gt;</rawHTML>
<rawHTML/>
The number of digits passed the decimal separator passed to lat, up to 8, will be tracked so that the lat is returned in a status object it will have the same number of digits after the decimal separator.
<rawHTML>&gt;</rawHTML>
<rawHTML/>
Please make sure to use to use a decimal point as the separator (and not the decimal comma) for the latitude and the longitude - usage of the decimal comma will cause the geo-tagged portion of the status update to be dropped.
<rawHTML>&gt;</rawHTML>
<rawHTML/>
For JSON, the response mostly uses conventions described in GeoJSON. Unfortunately, the geo object has coordinates that Twitter renderers are reversed from the GeoJSON specification (GeoJSON specifies a longitude then a latitude, whereas we are currently representing it as a latitude then a longitude. Our JSON renders as: &quot;geo&quot;: { &quot;type&quot;:&quot;Point&quot;, &quot;coordinates&quot;:[37.78217, -122.40062] }
<rawHTML>&gt;</rawHTML>
<rawHTML/>
The coordinates object is replacing the geo object (no deprecation date has been set for the geo object yet) -- the difference is that the coordinates object, in JSON, is now rendered correctly in GeoJSON.
<rawHTML>&gt;</rawHTML>
<rawHTML/>
If a place_id is passed into the status update, then that place will be attached to the status. If no place_id was explicitly provided, but latitude and longitude are, we attempt to implicitly provide a place by calling geo/reverse_geocode.
<rawHTML>&gt;</rawHTML>
<rawHTML/>
Users will have the ability, from their settings page, to remove all the geotags from all their tweets en masse. Currently we are not doing any automatic scrubbing nor providing a method to remove geotags from individual tweets.
<rawHTML>&gt;</rawHTML>
<rawHTML>&gt;</rawHTML></Para>
<Para>See:</Para>
<Para>
<rawHTML/>
<rawHTML/>https://dev.twitter.com/notifications/multiple-media-entities-in-tweets
<rawHTML>&gt;</rawHTML>
<rawHTML/>
https://dev.twitter.com/docs/api/multiple-media-extended-entities
<rawHTML>&gt;</rawHTML>
<rawHTML>&gt;</rawHTML></Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTweets.swift" line="219">
<Name>postStatusRetweetWithID(_:trimUser:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter23postStatusRetweetWithIDFS0_FTSi8trimUserGSqSb_7successGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postStatusRetweetWithID(id: Int, trimUser: Bool?, success: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST statuses/retweet/:id</Para>
</Abstract>
<Discussion>
<Para>Retweets a tweet. Returns the original tweet with retweet details embedded.</Para>
<Para>
<rawHTML/>
<rawHTML/>This method is subject to update limits. A HTTP 403 will be returned if this limit as been hit.
<rawHTML>&gt;</rawHTML>
<rawHTML/>
Twitter will ignore attempts to perform duplicate retweets.
<rawHTML>&gt;</rawHTML>
<rawHTML/>
The retweet_count will be current as of when the payload is generated and may not reflect the exact count. It is intended as an approximation.
<rawHTML>&gt;</rawHTML>
<rawHTML>&gt;</rawHTML></Para>
<Para>Returns Tweets (1: the new tweet)</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTweets.swift" line="243">
<Name>getStatusesOEmbedWithID(_:maxWidth:hideMedia:hideThread:omitScript:align:related:lang:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter23getStatusesOEmbedWithIDFS0_FTSi8maxWidthGSqSi_9hideMediaGSqSb_10hideThreadGSqSb_10omitScriptGSqSb_5alignGSqSS_7relatedGSqSS_4langGSqSS_7successGSqFT6statusGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getStatusesOEmbedWithID(id: Int, maxWidth: Int?, hideMedia: Bool?, hideThread: Bool?, omitScript: Bool?, align: String?, related: String?, lang: String?, success: ((status: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET statuses/oembed</Para>
</Abstract>
<Discussion>
<Para>Returns information allowing the creation of an embedded representation of a Tweet on third party sites. See the oEmbed specification for information about the response format.</Para>
<Para>While this endpoint allows a bit of customization for the final appearance of the embedded Tweet, be aware that the appearance of the rendered Tweet may change over time to be consistent with Twitter's Display Requirements. Do not rely on any class or id parameters to stay constant in the returned markup.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTweets.swift" line="324">
<Name>getStatusesRetweetersWithID(_:cursor:stringifyIDs:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter27getStatusesRetweetersWithIDFS0_FTSi6cursorGSqSi_12stringifyIDsGSqSb_7successGSqFT3idsGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getStatusesRetweetersWithID(id: Int, cursor: Int?, stringifyIDs: Bool?, success: ((ids: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET statuses/retweeters/ids</Para>
</Abstract>
<Discussion>
<Para>Returns a collection of up to 100 user IDs belonging to users who have retweeted the tweet specified by the id parameter.</Para>
<Para>This method offers similar data to GET statuses/retweets/:id and replaces API v1's GET statuses/:id/retweeted_by/ids method.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTweets.swift" line="355">
<Name>getStatusesLookupTweetIDs(_:includeEntities:map:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter25getStatusesLookupTweetIDsFS0_FTGSaSi_15includeEntitiesGSqSb_3mapGSqSb_7successGSqFT8statusesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getStatusesLookupTweetIDs(tweetIDs: [Int], includeEntities: Bool?, map: Bool?, success: ((statuses: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET statuses/lookup</Para>
</Abstract>
<Discussion>
<Para>Returns fully-hydrated tweet objects for up to 100 tweets per request, as specified by comma-separated values passed to the id parameter. This method is especially useful to get the details (hydrate) a collection of Tweet IDs. GET statuses/show/:id is used to retrieve a single tweet object.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterMessages.swift" line="35">
<Name>getDirectMessagesSinceID(_:maxID:count:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter24getDirectMessagesSinceIDFS0_FTGSqSi_5maxIDGSqSi_5countGSqSi_15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT8messagesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getDirectMessagesSinceID(sinceID: Int?, maxID: Int?, count: Int?, includeEntities: Bool?, skipStatus: Bool?, success: ((messages: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET direct_messages</Para>
</Abstract>
<Discussion>
<Para>Returns the 20 most recent direct messages sent to the authenticating user. Includes detailed information about the sender and recipient user. You can request up to 200 direct messages per call, up to a maximum of 800 incoming DMs.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterMessages.swift" line="69">
<Name>getSentDirectMessagesSinceID(_:maxID:count:page:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter28getSentDirectMessagesSinceIDFS0_FTGSqSi_5maxIDGSqSi_5countGSqSi_4pageGSqSi_15includeEntitiesGSqSb_7successGSqFT8messagesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getSentDirectMessagesSinceID(sinceID: Int?, maxID: Int?, count: Int?, page: Int?, includeEntities: Bool?, success: ((messages: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET direct_messages/sent</Para>
</Abstract>
<Discussion>
<Para>Returns the 20 most recent direct messages sent by the authenticating user. Includes detailed information about the sender and recipient user. You can request up to 200 direct messages per call, up to a maximum of 800 outgoing DMs.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterMessages.swift" line="103">
<Name>getDirectMessagesShowWithID(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter27getDirectMessagesShowWithIDFS0_FTSi7successGSqFT8messagesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getDirectMessagesShowWithID(id: Int, success: ((messages: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET direct_messages/show</Para>
</Abstract>
<Discussion>
<Para>Returns a single direct message, specified by an id parameter. Like the /1.1/direct_messages.format request, this method will include the user objects of the sender and recipient.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterMessages.swift" line="123">
<Name>postDestroyDirectMessageWithID(_:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter30postDestroyDirectMessageWithIDFS0_FTSi15includeEntitiesGSqSb_7successGSqFT8messagesGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postDestroyDirectMessageWithID(id: Int, includeEntities: Bool?, success: ((messages: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST direct_messages/destroy</Para>
</Abstract>
<Discussion>
<Para>Destroys the direct message specified in the required ID parameter. The authenticating user must be the recipient of the specified direct message.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterMessages.swift" line="147">
<Name>postDirectMessagesWithStatus(_:to:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter28postDirectMessagesWithStatusFS0_FTSS2toSS7successGSqFT8messagesGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postDirectMessagesWithStatus(status: String, to screenName: String, success: ((messages: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST direct_messages/new</Para>
</Abstract>
<Discussion>
<Para>Sends a new direct message to the specified user from the authenticating user. Requires both the user and text parameters and must be a POST. Returns the sent message in the requested format if successful.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterSpam.swift" line="35">
<Name>postUsersReportSpamWithScreenName(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter33postUsersReportSpamWithScreenNameFS0_FTSS7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postUsersReportSpamWithScreenName(screenName: String, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST users/report_spam</Para>
</Abstract>
<Discussion>
<Para>Report the specified user as a spam account to Twitter. Additionally performs the equivalent of POST blocks/create on behalf of the authenticated user.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="39">
<Name>getListsSubscribedByUserWithReverse(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter35getListsSubscribedByUserWithReverseFS0_FTGSqSb_7successGSqFT5listsGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getListsSubscribedByUserWithReverse(reverse: Bool?, success: ((lists: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET lists/list</Para>
</Abstract>
<Discussion>
<Para>Returns all lists the authenticating or specified user subscribes to, including their own. The user is specified using the user_id or screen_name parameters. If no user is given, the authenticating user is used.</Para>
<Para>This method used to be GET lists in version 1.0 of the API and has been renamed for consistency with other call.</Para>
<Para>A maximum of 100 results will be returned by this call. Subscribed lists are returned first, followed by owned lists. This means that if a user subscribes to 90 lists and owns 20 lists, this method returns 90 subscriptions and 10 owned lists. The reverse method returns owned lists first, so with reverse=true, 20 owned lists and 80 subscriptions would be returned. If your goal is to obtain every list a user owns or subscribes to, use GET lists/ownerships and/or GET lists/subscriptions instead.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="99">
<Name>getListsStatusesWithListID(_:ownerScreenName:sinceID:maxID:count:includeEntities:includeRTs:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter26getListsStatusesWithListIDFS0_FTSi15ownerScreenNameSS7sinceIDGSqSi_5maxIDGSqSi_5countGSqSi_15includeEntitiesGSqSb_10includeRTsGSqSb_7successGSqFT8statusesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getListsStatusesWithListID(listID: Int, ownerScreenName: String, sinceID: Int?, maxID: Int?, count: Int?, includeEntities: Bool?, includeRTs: Bool?, success: ((statuses: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET lists/statuses</Para>
</Abstract>
<Discussion>
<Para>Returns a timeline of tweets authored by members of the specified list. Retweets are included by default. Use the include_rts=false parameter to omit retweets. Embedded Timelines is a great way to embed list timelines on your website.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="232">
<Name>postListsMembersDestroyWithListID(_:userID:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter33postListsMembersDestroyWithListIDFS0_FTSi6userIDSi7successGSqFT8responseGSqOS_4JSON__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postListsMembersDestroyWithListID(listID: Int, userID: Int, success: ((response: JSON?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST lists/members/destroy</Para>
</Abstract>
<Discussion>
<Para>Removes the specified member from the list. The authenticated user must be the list's owner to remove members from the list.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="337">
<Name>getListsMembershipsWithUserID(_:cursor:filterToOwnedLists:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter29getListsMembershipsWithUserIDFS0_FTSi6cursorGSqSi_18filterToOwnedListsGSqSb_7successGSqFT5listsGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getListsMembershipsWithUserID(userID: Int, cursor: Int?, filterToOwnedLists: Bool?, success: ((lists: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET lists/memberships</Para>
</Abstract>
<Discussion>
<Para>Returns the lists the specified user has been added to. If user_id or screen_name are not provided the memberships for the authenticating user are returned.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="394">
<Name>getListsSubscribersWithListID(_:ownerScreenName:cursor:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter29getListsSubscribersWithListIDFS0_FTSi15ownerScreenNameGSqSS_6cursorGSqSi_15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT5usersGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getListsSubscribersWithListID(listID: Int, ownerScreenName: String?, cursor: Int?, includeEntities: Bool?, skipStatus: Bool?, success: ((users: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET lists/subscribers</Para>
</Abstract>
<Discussion>
<Para>Returns the subscribers of the specified list. Private list subscribers will only be shown if the authenticated user owns the specified list.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="523">
<Name>postListsSubscribersCreateWithListID(_:ownerScreenName:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter36postListsSubscribersCreateWithListIDFS0_FTSi15ownerScreenNameSS7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postListsSubscribersCreateWithListID(listID: Int, ownerScreenName: String, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST lists/subscribers/create</Para>
</Abstract>
<Discussion>
<Para>Subscribes the authenticated user to the specified list.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="592">
<Name>getListsSubscribersShowWithListID(_:userID:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter33getListsSubscribersShowWithListIDFS0_FTSi6userIDSi15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getListsSubscribersShowWithListID(listID: Int, userID: Int, includeEntities: Bool?, skipStatus: Bool?, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET lists/subscribers/show</Para>
</Abstract>
<Discussion>
<Para>Check if the specified user is a subscriber of the specified list. Returns the user if they are subscriber.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="739">
<Name>postListsSubscribersDestroyWithListID(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter37postListsSubscribersDestroyWithListIDFS0_FTSi7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postListsSubscribersDestroyWithListID(listID: Int, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST lists/subscribers/destroy</Para>
</Abstract>
<Discussion>
<Para>Unsubscribes the authenticated user from the specified list.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="793">
<Name>postListsMembersCreateWithListID(_:userIDs:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter32postListsMembersCreateWithListIDFS0_FTSi7userIDsGSaSi_15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT8responseGSqOS_4JSON__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postListsMembersCreateWithListID(listID: Int, userIDs: [Int], includeEntities: Bool?, skipStatus: Bool?, success: ((response: JSON?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST lists/members/create_all</Para>
</Abstract>
<Discussion>
<Para>Adds multiple members to a list, by specifying a comma-separated list of member ids or screen names. The authenticated user must own the list to be able to add members to it. Note that lists can't have more than 5,000 members, and you are limited to adding up to 100 members to a list at a time with this method.</Para>
<Para>Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="946">
<Name>getListsMembersShowWithListID(_:userID:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter29getListsMembersShowWithListIDFS0_FTSi6userIDSi15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getListsMembersShowWithListID(listID: Int, userID: Int, includeEntities: Bool?, skipStatus: Bool?, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET lists/members/show</Para>
</Abstract>
<Discussion>
<Para>Check if the specified user is a member of the specified list.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="1069">
<Name>getListsMembersShowWithSlug(_:ownerScreenName:screenName:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter27getListsMembersShowWithSlugFS0_FTSS15ownerScreenNameSi10screenNameSi15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getListsMembersShowWithSlug(slug: String, ownerScreenName: Int, screenName: Int, includeEntities: Bool?, skipStatus: Bool?, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET lists/members</Para>
</Abstract>
<Discussion>
<Para>Returns the members of the specified list. Private list members will only be shown if the authenticated user owns the specified list.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="1223">
<Name>postListsMembersCreateWithListID(_:ownerScreenName:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter32postListsMembersCreateWithListIDFS0_FTSi15ownerScreenNameSS7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postListsMembersCreateWithListID(listID: Int, ownerScreenName: String, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST lists/members/create</Para>
</Abstract>
<Discussion>
<Para>Creates a new list for the authenticated user. Note that you can't create more than 20 lists per account.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="1292">
<Name>postListsDestroyWithListID(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter26postListsDestroyWithListIDFS0_FTSi7successGSqFT4listGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postListsDestroyWithListID(listID: Int, success: ((list: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST lists/destroy</Para>
</Abstract>
<Discussion>
<Para>Deletes the specified list. The authenticated user must own the list to be able to destroy it.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="1344">
<Name>postListsUpdateWithListID(_:name:publicMode:description:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter25postListsUpdateWithListIDFS0_FTSi4nameGSqSS_10publicModeGSqSb_11descriptionGSqSS_7successGSqFT4listGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postListsUpdateWithListID(listID: Int, name: String?, publicMode: Bool?, description: String?, success: ((list: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST lists/update</Para>
</Abstract>
<Discussion>
<Para>Updates the specified list. The authenticated user must own the list to be able to update it.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="1441">
<Name>postListsCreateWithName(_:publicMode:description:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter23postListsCreateWithNameFS0_FTSS10publicModeGSqSb_11descriptionGSqSS_7successGSqFT4listGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postListsCreateWithName(name: String, publicMode: Bool?, description: String?, success: ((list: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST lists/create</Para>
</Abstract>
<Discussion>
<Para>Creates a new list for the authenticated user. Note that you can't create more than 20 lists per account.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="1473">
<Name>getListsShowWithID(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter18getListsShowWithIDFS0_FTSi7successGSqFT4listGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getListsShowWithID(listID: Int, success: ((list: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET lists/show</Para>
</Abstract>
<Discussion>
<Para>Returns the specified list. Private lists will only be shown if the authenticated user owns the specified list.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="1525">
<Name>getListsSubscriptionsWithUserID(_:count:cursor:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter31getListsSubscriptionsWithUserIDFS0_FTSi5countGSqSi_6cursorGSqSi_7successGSqFT5listsGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getListsSubscriptionsWithUserID(userID: Int, count: Int?, cursor: Int?, success: ((lists: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET lists/subscriptions</Para>
</Abstract>
<Discussion>
<Para>Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default. Does not include the user's own lists.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="1584">
<Name>postListsMembersDestroyAllWithListID(_:userIDs:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter36postListsMembersDestroyAllWithListIDFS0_FTSi7userIDsGSaSi_7successGSqFT8responseGSqOS_4JSON__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postListsMembersDestroyAllWithListID(listID: Int, userIDs: [Int], success: ((response: JSON?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST lists/members/destroy_all</Para>
</Abstract>
<Discussion>
<Para>Removes multiple members from a list, by specifying a comma-separated list of member ids or screen names. The authenticated user must own the list to be able to remove members from it. Note that lists can't have more than 500 members, and you are limited to removing up to 100 members to a list at a time with this method.</Para>
<Para>Please note that there can be issues with lists that rapidly remove and add memberships. Take care when using these methods such that you are not too rapidly switching between removals and adds on the same list.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterLists.swift" line="1697">
<Name>getListsOwnershipsWithUserID(_:count:cursor:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter28getListsOwnershipsWithUserIDFS0_FTSi5countGSqSi_6cursorGSqSi_7successGSqFT5listsGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getListsOwnershipsWithUserID(userID: Int, count: Int?, cursor: Int?, success: ((lists: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET lists/ownerships</Para>
</Abstract>
<Discussion>
<Para>Returns the lists owned by the specified Twitter user. Private lists will only be shown if the authenticated user is also the owner of the lists.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterPlaces.swift" line="35">
<Name>getGeoIDWithPlaceID(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter19getGeoIDWithPlaceIDFS0_FTSS7successGSqFT5placeGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getGeoIDWithPlaceID(placeID: String, success: ((place: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET geo/id/:place_id</Para>
</Abstract>
<Discussion>
<Para>Returns all the information about a known place.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterPlaces.swift" line="54">
<Name>getGeoReverseGeocodeWithLat(_:long:accuracy:granularity:maxResults:callback:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter27getGeoReverseGeocodeWithLatFS0_FTSd4longSd8accuracyGSqSS_11granularityGSqSS_10maxResultsGSqSi_8callbackGSqSS_7successGSqFT5placeGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getGeoReverseGeocodeWithLat(lat: Double, long: Double, accuracy: String?, granularity: String?, maxResults: Int?, callback: String?, success: ((place: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET geo/reverse_geocode</Para>
</Abstract>
<Discussion>
<Para>Given a latitude and a longitude, searches for up to 20 places that can be used as a place_id when updating a status.</Para>
<Para>This request is an informative call and will deliver generalized results about geography.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterPlaces.swift" line="92">
<Name>getGeoSearchWithLat(_:long:query:ipAddress:accuracy:granularity:maxResults:containedWithin:attributeStreetAddress:callback:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter19getGeoSearchWithLatFS0_FTGSqSd_4longGSqSd_5queryGSqSS_9ipAddressGSqSS_8accuracyGSqSS_11granularityGSqSS_10maxResultsGSqSi_15containedWithinGSqSS_22attributeStreetAddressGSqSS_8callbackGSqSS_7successGSqFT6placesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getGeoSearchWithLat(lat: Double?, long: Double?, query: String?, ipAddress: String?, accuracy: String?, granularity: String?, maxResults: Int?, containedWithin: String?, attributeStreetAddress: String?, callback: String?, success: ((places: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET geo/search</Para>
</Abstract>
<Discussion>
<Para>Search for places that can be attached to a statuses/update. Given a latitude and a longitude pair, an IP address, or a name, this request will return a list of all the valid places that can be used as the place_id when updating a status.</Para>
<Para>Conceptually, a query can be made from the user's location, retrieve a list of places, have the user validate the location he or she is at, and then send the ID of this location with a call to POST statuses/update.</Para>
<Para>This is the recommended method to use find places that can be attached to statuses/update. Unlike GET geo/reverse_geocode which provides raw data access, this endpoint can potentially re-order places with regards to the user who is authenticated. This approach is also preferred for interactive place matching with the user.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterPlaces.swift" line="148">
<Name>getGeoSimilarPlacesWithLat(_:long:name:containedWithin:attributeStreetAddress:callback:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter26getGeoSimilarPlacesWithLatFS0_FTSd4longSd4nameSS15containedWithinGSqSS_22attributeStreetAddressGSqSS_8callbackGSqSS_7successGSqFT6placesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getGeoSimilarPlacesWithLat(lat: Double, long: Double, name: String, containedWithin: String?, attributeStreetAddress: String?, callback: String?, success: ((places: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET geo/similar_places</Para>
</Abstract>
<Discussion>
<Para>Locates places near the given coordinates which are similar in name.</Para>
<Para>Conceptually you would use this method to get a list of known places to choose from first. Then, if the desired place doesn't exist, make a request to POST geo/place to create a new one.</Para>
<Para>The token contained in the response is the token needed to be able to create a new place.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTrends.swift" line="22">
<Name>getTrendsPlaceWithWOEID(_:excludeHashtags:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter23getTrendsPlaceWithWOEIDFS0_FTSi15excludeHashtagsGSqSb_7successGSqFT6trendsGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getTrendsPlaceWithWOEID(id: Int, excludeHashtags: Bool?, success: ((trends: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET trends/place</Para>
</Abstract>
<Discussion>
<Para>Returns the top 10 trending topics for a specific WOEID, if trending information is available for it.</Para>
<Para>The response is an array of &quot;trend&quot; objects that encode the name of the trending topic, the query parameter that can be used to search for the topic on Twitter Search, and the Twitter Search URL.</Para>
<Para>This information is cached for 5 minutes. Requesting more frequently than that will not return any more data, and will count against your rate limit usage.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTrends.swift" line="52">
<Name>getTrendsAvailableWithSuccess(_:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter29getTrendsAvailableWithSuccessFS0_FTGSqFT6trendsGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getTrendsAvailableWithSuccess(success: ((trends: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET trends/available</Para>
</Abstract>
<Discussion>
<Para>Returns the locations that Twitter has trending topic information for.</Para>
<Para>The response is an array of &quot;locations&quot; that encode the location's WOEID and some other human-readable information such as a canonical name and country the location belongs in.</Para>
<Para>A WOEID is a Yahoo! Where On Earth ID.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTrends.swift" line="73">
<Name>getTrendsClosestWithLat(_:long:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter23getTrendsClosestWithLatFS0_FTSi4longSi7successGSqFT6trendsGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getTrendsClosestWithLat(lat: Int, long: Int, success: ((trends: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET trends/closest</Para>
</Abstract>
<Discussion>
<Para>Returns the locations that Twitter has trending topic information for, closest to a specified location.</Para>
<Para>The response is an array of &quot;locations&quot; that encode the location's WOEID and some other human-readable information such as a canonical name and country the location belongs in.</Para>
<Para>A WOEID is a Yahoo! Where On Earth ID.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="35">
<Name>getAccountSettingsWithSuccess(_:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter29getAccountSettingsWithSuccessFS0_FTGSqFT8settingsGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getAccountSettingsWithSuccess(success: ((settings: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET account/settings</Para>
</Abstract>
<Discussion>
<Para>Returns settings (including current trend, geo and sleep time information) for the authenticating user.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="52">
<Name>getAccountVerifyCredentials(_:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter27getAccountVerifyCredentialsFS0_FTGSqSb_10skipStatusGSqSb_7successGSqFT6myInfoGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getAccountVerifyCredentials(includeEntities: Bool?, skipStatus: Bool?, success: ((myInfo: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET account/verify_credentials</Para>
</Abstract>
<Discussion>
<Para>Returns an HTTP 200 OK response code and a representation of the requesting user if authentication was successful; returns a 401 status code and an error message if not. Use this method to test if supplied user credentials are valid.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="77">
<Name>postAccountSettings(_:sleepTimeEnabled:startSleepTime:endSleepTime:timeZone:lang:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter19postAccountSettingsFS0_FTGSqSi_16sleepTimeEnabledGSqSb_14startSleepTimeGSqSi_12endSleepTimeGSqSi_8timeZoneGSqSS_4langGSqSS_7successGSqFT8settingsGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postAccountSettings(trendLocationWOEID: Int?, sleepTimeEnabled: Bool?, startSleepTime: Int?, endSleepTime: Int?, timeZone: String?, lang: String?, success: ((settings: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST account/settings</Para>
</Abstract>
<Discussion>
<Para>Updates the authenticating user's settings.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="116">
<Name>postAccountUpdateDeliveryDeviceSMS(_:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter34postAccountUpdateDeliveryDeviceSMSFS0_FTSb15includeEntitiesGSqSb_7successGSqFT22deliveryDeviceSettingsGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postAccountUpdateDeliveryDeviceSMS(device: Bool, includeEntities: Bool?, success: ((deliveryDeviceSettings: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST account/update_delivery_device</Para>
</Abstract>
<Discussion>
<Para>Sets which device Twitter delivers updates to for the authenticating user. Sending none as the device parameter will disable SMS updates.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="144">
<Name>postAccountUpdateProfileWithName(_:url:location:description:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter32postAccountUpdateProfileWithNameFS0_FTGSqSS_3urlGSqSS_8locationGSqSS_11descriptionGSqSS_15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT7profileGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postAccountUpdateProfileWithName(name: String?, url: String?, location: String?, description: String?, includeEntities: Bool?, skipStatus: Bool?, success: ((profile: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST account/update_profile</Para>
</Abstract>
<Discussion>
<Para>Sets values that users are able to set under the &quot;Account&quot; tab of their settings page. Only the parameters specified will be updated.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="183">
<Name>postAccountUpdateProfileBackgroundImage(_:title:includeEntities:use:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter39postAccountUpdateProfileBackgroundImageFS0_FTGSqCSo6NSData_5titleGSqSS_15includeEntitiesGSqSb_3useGSqSb_7successGSqFT7profileGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postAccountUpdateProfileBackgroundImage(imageData: NSData?, title: String?, includeEntities: Bool?, use: Bool?, success: ((profile: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST account/update_profile_background_image</Para>
</Abstract>
<Discussion>
<Para>Updates the authenticating user's profile background image. This method can also be used to enable or disable the profile background image. Although each parameter is marked as optional, at least one of image, tile or use must be provided when making this request.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="216">
<Name>postUpdateAccountProfileColors(_:profileLinkColor:profileSidebarBorderColor:profileSidebarFillColor:profileTextColor:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter30postUpdateAccountProfileColorsFS0_FTGSqSS_16profileLinkColorGSqSS_25profileSidebarBorderColorGSqSS_23profileSidebarFillColorGSqSS_16profileTextColorGSqSS_15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT7profileGSqGVSs10DictionarySSOS_4JSON___T__7failureFT5errorCSo7NSError_T__T_</USR>
<Declaration>public func postUpdateAccountProfileColors(profileBackgroundColor: String?, profileLinkColor: String?, profileSidebarBorderColor: String?, profileSidebarFillColor: String?, profileTextColor: String?, includeEntities: Bool?, skipStatus: Bool?, success: ((profile: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler)</Declaration>
<Abstract>
<Para>POST account/update_profile_colors</Para>
</Abstract>
<Discussion>
<Para>Sets one or more hex values that control the color scheme of the authenticating user's profile page on twitter.com. Each parameter's value must be a valid hexidecimal value, and may be either three or six characters (ex: #fff or #ffffff).</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="259">
<Name>postAccountUpdateProfileImage(_:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter29postAccountUpdateProfileImageFS0_FTGSqCSo6NSData_15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT7profileGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postAccountUpdateProfileImage(imageData: NSData?, includeEntities: Bool?, skipStatus: Bool?, success: ((profile: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST account/update_profile_image</Para>
</Abstract>
<Discussion>
<Para>Updates the authenticating user's profile image. Note that this method expects raw multipart data, not a URL to an image.</Para>
<Para>This method asynchronously processes the uploaded file before updating the user's profile image URL. You can either update your local cache the next time you request the user's information, or, at least 5 seconds after uploading the image, ask for the updated URL using GET users/show.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="287">
<Name>getBlockListWithIncludeEntities(_:skipStatus:cursor:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter31getBlockListWithIncludeEntitiesFS0_FTGSqSb_10skipStatusGSqSb_6cursorGSqSi_7successGSqFT5usersGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getBlockListWithIncludeEntities(includeEntities: Bool?, skipStatus: Bool?, cursor: Int?, success: ((users: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET blocks/list</Para>
</Abstract>
<Discussion>
<Para>Returns a collection of user objects that the authenticating user is blocking.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="319">
<Name>getBlockIDsWithStingifyIDs(_:cursor:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter26getBlockIDsWithStingifyIDsFS0_FTGSqSS_6cursorGSqSi_7successGSqFT3idsGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureFT5errorCSo7NSError_T__T_</USR>
<Declaration>public func getBlockIDsWithStingifyIDs(stringifyIDs: String?, cursor: Int?, success: ((ids: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler)</Declaration>
<Abstract>
<Para>GET blocks/ids</Para>
</Abstract>
<Discussion>
<Para>Returns an array of numeric user ids the authenticating user is blocking.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="348">
<Name>postBlocksCreateWithScreenName(_:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter30postBlocksCreateWithScreenNameFS0_FTSS15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureFT5errorCSo7NSError_T__T_</USR>
<Declaration>public func postBlocksCreateWithScreenName(screenName: String, includeEntities: Bool?, skipStatus: Bool?, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler)</Declaration>
<Abstract>
<Para>POST blocks/create</Para>
</Abstract>
<Discussion>
<Para>Blocks the specified user from following the authenticating user. In addition the blocked user will not show in the authenticating users mentions or timeline (unless retweeted by another user). If a follow or friend relationship exists it is destroyed.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="397">
<Name>postDestroyBlocksWithUserID(_:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter27postDestroyBlocksWithUserIDFS0_FTSi15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureFT5errorCSo7NSError_T__T_</USR>
<Declaration>public func postDestroyBlocksWithUserID(userID: Int, includeEntities: Bool?, skipStatus: Bool?, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler)</Declaration>
<Abstract>
<Para>POST blocks/destroy</Para>
</Abstract>
<Discussion>
<Para>Un-blocks the user specified in the ID parameter for the authenticating user. Returns the un-blocked user in the requested format when successful. If relationships existed before the block was instated, they will not be restored.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="458">
<Name>getUsersLookupWithScreenNames(_:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter29getUsersLookupWithScreenNamesFS0_FTGSaSS_15includeEntitiesGSqSb_7successGSqFT5usersGSqGSaOS_4JSON___T__7failureFT5errorCSo7NSError_T__T_</USR>
<Declaration>public func getUsersLookupWithScreenNames(screenNames: [String], includeEntities: Bool?, success: ((users: [JSONValue]?) -&gt; Void)?, failure: FailureHandler)</Declaration>
<Abstract>
<Para>GET users/lookup</Para>
</Abstract>
<Discussion>
<Para>Returns fully-hydrated user objects for up to 100 users per request, as specified by comma-separated values passed to the user_id and/or screen_name parameters.</Para>
<Para>This method is especially useful when used in conjunction with collections of user IDs returned from GET friends/ids and GET followers/ids.</Para>
<Para>GET users/show is used to retrieve a single user object.</Para>
<Para>There are a few things to note when using this method.</Para>
<Para>
<rawHTML/>
<rawHTML/>You must be following a protected user to be able to see their most recent status update. If you don't follow a protected user their status will be removed.
<rawHTML>&gt;</rawHTML>
<rawHTML/>
The order of user IDs or screen names may not match the order of users in the returned array.
<rawHTML>&gt;</rawHTML>
<rawHTML/>
If a requested user is unknown, suspended, or deleted, then that user will not be returned in the results list.
<rawHTML>&gt;</rawHTML>
<rawHTML/>
If none of your lookup criteria can be satisfied by returning a user object, a HTTP 404 will be thrown.
<rawHTML>&gt;</rawHTML>
<rawHTML/>
You are strongly encouraged to use a POST for larger requests.
<rawHTML>&gt;</rawHTML>
<rawHTML>&gt;</rawHTML></Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="505">
<Name>getUsersShowWithScreenName(_:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter26getUsersShowWithScreenNameFS0_FTSS15includeEntitiesGSqSb_7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureFT5errorCSo7NSError_T__T_</USR>
<Declaration>public func getUsersShowWithScreenName(screenName: String, includeEntities: Bool?, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler)</Declaration>
<Abstract>
<Para>GET users/show</Para>
</Abstract>
<Discussion>
<Para>Returns a variety of information about the user specified by the required user_id or screen_name parameter. The author's most recent Tweet will be returned inline when possible. GET users/lookup is used to retrieve a bulk collection of user objects.</Para>
<Para>You must be following a protected user to be able to see their most recent Tweet. If you don't follow a protected user, the users Tweet will be removed. A Tweet will not always be returned in the current_status field.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="550">
<Name>getUsersSearchWithQuery(_:page:count:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter23getUsersSearchWithQueryFS0_FTSS4pageGSqSi_5countGSqSi_15includeEntitiesGSqSb_7successGSqFT5usersGSqGSaOS_4JSON___T__7failureFT5errorCSo7NSError_T__T_</USR>
<Declaration>public func getUsersSearchWithQuery(q: String, page: Int?, count: Int?, includeEntities: Bool?, success: ((users: [JSONValue]?) -&gt; Void)?, failure: FailureHandler)</Declaration>
<Abstract>
<Para>GET users/search</Para>
</Abstract>
<Discussion>
<Para>Provides a simple, relevance-based search interface to public user accounts on Twitter. Try querying by topical interest, full name, company name, location, or other criteria. Exact match searches are not supported.</Para>
<Para>Only the first 1,000 matching results are available.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="580">
<Name>getUsersContributeesWithUserID(_:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter30getUsersContributeesWithUserIDFS0_FTSi15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT5usersGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getUsersContributeesWithUserID(id: Int, includeEntities: Bool?, skipStatus: Bool?, success: ((users: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET users/contributees</Para>
</Abstract>
<Discussion>
<Para>Returns a collection of users that the specified user can &quot;contribute&quot; to.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="629">
<Name>getUsersContributorsWithUserID(_:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter30getUsersContributorsWithUserIDFS0_FTSi15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT5usersGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getUsersContributorsWithUserID(id: Int, includeEntities: Bool?, skipStatus: Bool?, success: ((users: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET users/contributors</Para>
</Abstract>
<Discussion>
<Para>Returns a collection of users who can contribute to the specified account.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="678">
<Name>postAccountRemoveProfileBannerWithSuccess(_:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter41postAccountRemoveProfileBannerWithSuccessFS0_FTGSqFT8responseOS_4JSON_T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postAccountRemoveProfileBannerWithSuccess(success: ((response: JSON) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST account/remove_profile_banner</Para>
</Abstract>
<Discussion>
<Para>Removes the uploaded profile banner for the authenticating user. Returns HTTP 200 upon success.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="704">
<Name>postAccountUpdateProfileBannerWithImageData(_:width:height:offsetLeft:offsetTop:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter43postAccountUpdateProfileBannerWithImageDataFS0_FTGSqCSo6NSData_5widthGSqSi_6heightGSqSi_10offsetLeftGSqSi_9offsetTopGSqSi_7successGSqFT8responseOS_4JSON_T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postAccountUpdateProfileBannerWithImageData(imageData: NSData?, width: Int?, height: Int?, offsetLeft: Int?, offsetTop: Int?, success: ((response: JSON) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST account/update_profile_banner</Para>
</Abstract>
<Discussion>
<Para>Uploads a profile banner on behalf of the authenticating user. For best results, upload an &lt;5MB image that is exactly 1252px by 626px. Images will be resized for a number of display options. Users with an uploaded profile banner will have a profile_banner_url node in their Users objects. More information about sizing variations can be found in User Profile Images and Banners and GET users/profile_banner.</Para>
<Para>Profile banner images are processed asynchronously. The profile_banner_url and its variant sizes will not necessary be available directly after upload.</Para>
<Para>If providing any one of the height, width, offset_left, or offset_top parameters, you must provide all of the sizing parameters.</Para>
<Para>HTTP Response Codes 200, 201, 202 Profile banner image succesfully uploaded 400 Either an image was not provided or the image data could not be processed 422 The image could not be resized or is too large.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="738">
<Name>getUsersProfileBannerWithUserID(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter31getUsersProfileBannerWithUserIDFS0_FTSi7successGSqFT8responseOS_4JSON_T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getUsersProfileBannerWithUserID(userID: Int, success: ((response: JSON) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET users/profile_banner</Para>
</Abstract>
<Discussion>
<Para>Returns a map of the available size variations of the specified user's profile banner. If the user has not uploaded a profile banner, a HTTP 404 will be served instead. This method can be used instead of string manipulation on the profile_banner_url returned in user objects as described in User Profile Images and Banners.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="759">
<Name>postMutesUsersCreateForScreenName(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter33postMutesUsersCreateForScreenNameFS0_FTSS7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postMutesUsersCreateForScreenName(screenName: String, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST mutes/users/create</Para>
</Abstract>
<Discussion>
<Para>Mutes the user specified in the ID parameter for the authenticating user.</Para>
<Para>Returns the muted user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.</Para>
<Para>Actions taken in this method are asynchronous and changes will be eventually consistent.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="798">
<Name>postMutesUsersDestroyForScreenName(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter34postMutesUsersDestroyForScreenNameFS0_FTSS7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postMutesUsersDestroyForScreenName(screenName: String, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST mutes/users/destroy</Para>
</Abstract>
<Discussion>
<Para>Un-mutes the user specified in the ID parameter for the authenticating user.</Para>
<Para>Returns the unmuted user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.</Para>
<Para>Actions taken in this method are asynchronous and changes will be eventually consistent.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="833">
<Name>getMutesUsersIDsWithCursor(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter26getMutesUsersIDsWithCursorFS0_FTGSqSi_7successGSqFT3idsGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getMutesUsersIDsWithCursor(cursor: Int?, success: ((ids: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET mutes/users/ids</Para>
</Abstract>
<Discussion>
<Para>Returns an array of numeric user ids the authenticating user has muted.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterUsers.swift" line="859">
<Name>getMutesUsersListWithCursor(_:includeEntities:skipStatus:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter27getMutesUsersListWithCursorFS0_FTGSqSi_15includeEntitiesGSqSb_10skipStatusGSqSb_7successGSqFT5usersGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getMutesUsersListWithCursor(cursor: Int?, includeEntities: Bool?, skipStatus: Bool?, success: ((users: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET mutes/users/list</Para>
</Abstract>
<Discussion>
<Para>Returns an array of user objects the authenticating user has muted.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="35">
<Name>getFriendshipsNoRetweetsIDsWithStringifyIDs(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter43getFriendshipsNoRetweetsIDsWithStringifyIDsFS0_FTGSqSb_7successGSqFT3idsGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getFriendshipsNoRetweetsIDsWithStringifyIDs(stringifyIDs: Bool?, success: ((ids: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET friendships/no_retweets/ids</Para>
</Abstract>
<Discussion>
<Para>Returns a collection of user_ids that the currently authenticated user does not want to receive retweets from. Use POST friendships/update to set the &quot;no retweets&quot; status for a given user account on behalf of the current user.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="60">
<Name>getFriendsIDsWithID(_:cursor:stringifyIDs:count:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter19getFriendsIDsWithIDFS0_FTSi6cursorGSqSi_12stringifyIDsGSqSb_5countGSqSi_7successGSqFT3idsGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getFriendsIDsWithID(id: Int, cursor: Int?, stringifyIDs: Bool?, count: Int?, success: ((ids: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET friends/ids Returns Users (*: user IDs for followees)</Para>
</Abstract>
<Discussion>
<Para>Returns a cursored collection of user IDs for every user the specified user is following (otherwise known as their &quot;friends&quot;).</Para>
<Para>At this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 5,000 user IDs and multiple &quot;pages&quot; of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information.</Para>
<Para>This method is especially powerful when used in conjunction with GET users/lookup, a method that allows you to convert user IDs into full user objects in bulk.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="127">
<Name>getFollowersIDsWithID(_:cursor:stringifyIDs:count:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter21getFollowersIDsWithIDFS0_FTSi6cursorGSqSi_12stringifyIDsGSqSb_5countGSqSi_7successGSqFT3idsGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getFollowersIDsWithID(id: Int, cursor: Int?, stringifyIDs: Bool?, count: Int?, success: ((ids: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET followers/ids</Para>
</Abstract>
<Discussion>
<Para>Returns a cursored collection of user IDs for every user following the specified user.</Para>
<Para>At this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 5,000 user IDs and multiple &quot;pages&quot; of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information.</Para>
<Para>This method is especially powerful when used in conjunction with GET users/lookup, a method that allows you to convert user IDs into full user objects in bulk.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="190">
<Name>getFriendshipsIncomingWithCursor(_:stringifyIDs:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter32getFriendshipsIncomingWithCursorFS0_FTGSqSS_12stringifyIDsGSqSS_7successGSqFT3idsGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getFriendshipsIncomingWithCursor(cursor: String?, stringifyIDs: String?, success: ((ids: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET friendships/incoming</Para>
</Abstract>
<Discussion>
<Para>Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="219">
<Name>getFriendshipsOutgoingWithCursor(_:stringifyIDs:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter32getFriendshipsOutgoingWithCursorFS0_FTGSqSS_12stringifyIDsGSqSS_7successGSqFT3idsGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getFriendshipsOutgoingWithCursor(cursor: String?, stringifyIDs: String?, success: ((ids: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET friendships/outgoing</Para>
</Abstract>
<Discussion>
<Para>Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="252">
<Name>postCreateFriendshipWithID(_:follow:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter26postCreateFriendshipWithIDFS0_FTSi6followGSqSb_7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postCreateFriendshipWithID(id: Int, follow: Bool?, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST friendships/create</Para>
</Abstract>
<Discussion>
<Para>Allows the authenticating users to follow the user specified in the ID parameter.</Para>
<Para>Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. If you are already friends with the user a HTTP 403 may be returned, though for performance reasons you may get a 200 OK message even if the friendship already exists.</Para>
<Para>Actions taken in this method are asynchronous and changes will be eventually consistent.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="299">
<Name>postDestroyFriendshipWithID(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter27postDestroyFriendshipWithIDFS0_FTSi7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postDestroyFriendshipWithID(id: Int, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST friendships/destroy</Para>
</Abstract>
<Discussion>
<Para>Allows the authenticating user to unfollow the user specified in the ID parameter.</Para>
<Para>Returns the unfollowed user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.</Para>
<Para>Actions taken in this method are asynchronous and changes will be eventually consistent.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="334">
<Name>postUpdateFriendshipWithID(_:device:retweets:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter26postUpdateFriendshipWithIDFS0_FTSi6deviceGSqSb_8retweetsGSqSb_7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func postUpdateFriendshipWithID(id: Int, device: Bool?, retweets: Bool?, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>POST friendships/update</Para>
</Abstract>
<Discussion>
<Para>Allows one to enable or disable retweets and device notifications from the specified user.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="383">
<Name>getFriendshipsShowWithSourceID(_:targetID:orTargetScreenName:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter30getFriendshipsShowWithSourceIDFS0_FTGSqSi_8targetIDGSqSi_18orTargetScreenNameGSqSS_7successGSqFT4userGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getFriendshipsShowWithSourceID(sourceID: Int?, targetID: Int?, orTargetScreenName targetScreenName: String?, success: ((user: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET friendships/show</Para>
</Abstract>
<Discussion>
<Para>Returns detailed information about the relationship between two arbitrary users.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="434">
<Name>getFriendsListWithID(_:cursor:count:skipStatus:includeUserEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter20getFriendsListWithIDFS0_FTSi6cursorGSqSi_5countGSqSi_10skipStatusGSqSb_19includeUserEntitiesGSqSb_7successGSqFT5usersGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getFriendsListWithID(id: Int, cursor: Int?, count: Int?, skipStatus: Bool?, includeUserEntities: Bool?, success: ((users: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET friends/list</Para>
</Abstract>
<Discussion>
<Para>Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their &quot;friends&quot;).</Para>
<Para>At this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 20 users and multiple &quot;pages&quot; of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="505">
<Name>getFollowersListWithID(_:cursor:count:skipStatus:includeUserEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter22getFollowersListWithIDFS0_FTSi6cursorGSqSi_5countGSqSi_10skipStatusGSqSb_19includeUserEntitiesGSqSb_7successGSqFT5usersGSqGSaOS_4JSON__14previousCursorGSqSi_10nextCursorGSqSi__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getFollowersListWithID(id: Int, cursor: Int?, count: Int?, skipStatus: Bool?, includeUserEntities: Bool?, success: ((users: [JSONValue]?, previousCursor: Int?, nextCursor: Int?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET followers/list</Para>
</Abstract>
<Discussion>
<Para>Returns a cursored collection of user objects for users following the specified user.</Para>
<Para>At this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 20 users and multiple &quot;pages&quot; of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterFollowers.swift" line="574">
<Name>getFriendshipsLookupWithScreenNames(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter35getFriendshipsLookupWithScreenNamesFS0_FTGSaSS_7successGSqFT11friendshipsGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getFriendshipsLookupWithScreenNames(screenNames: [String], success: ((friendships: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET friendships/lookup</Para>
</Abstract>
<Discussion>
<Para>Returns the relationships of the authenticating user to the comma-separated list of up to 100 screen_names or user_ids provided. Values for connections can be: following, following_requested, followed_by, none.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTimelines.swift" line="72">
<Name>getStatusesMentionTimelineWithCount(_:sinceID:maxID:trimUser:contributorDetails:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter35getStatusesMentionTimelineWithCountFS0_FTGSqSi_7sinceIDGSqSi_5maxIDGSqSi_8trimUserGSqSb_18contributorDetailsGSqSb_15includeEntitiesGSqSb_7successGSqFT8statusesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getStatusesMentionTimelineWithCount(count: Int?, sinceID: Int?, maxID: Int?, trimUser: Bool?, contributorDetails: Bool?, includeEntities: Bool?, success: ((statuses: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET statuses/mentions_timeline Returns Tweets (*: mentions for the user)</Para>
</Abstract>
<Discussion>
<Para>Returns the 20 most recent mentions (tweets containing a users's @screen_name) for the authenticating user.</Para>
<Para>The timeline returned is the equivalent of the one seen when you view your mentions on twitter.com.</Para>
<Para>This method can only return up to 800 tweets.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTimelines.swift" line="89">
<Name>getStatusesUserTimelineWithUserID(_:count:sinceID:maxID:trimUser:contributorDetails:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter33getStatusesUserTimelineWithUserIDFS0_FTSS5countGSqSi_7sinceIDGSqSi_5maxIDGSqSi_8trimUserGSqSb_18contributorDetailsGSqSb_15includeEntitiesGSqSb_7successGSqFT8statusesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getStatusesUserTimelineWithUserID(userID: String, count: Int?, sinceID: Int?, maxID: Int?, trimUser: Bool?, contributorDetails: Bool?, includeEntities: Bool?, success: ((statuses: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET statuses/user_timeline Returns Tweets (*: tweets for the user)</Para>
</Abstract>
<Discussion>
<Para>Returns a collection of the most recent Tweets posted by the user indicated by the screen_name or user_id parameters.</Para>
<Para>User timelines belonging to protected users may only be requested when the authenticated user either &quot;owns&quot; the timeline or is an approved follower of the owner.</Para>
<Para>The timeline returned is the equivalent of the one seen when you view a user's profile on twitter.com.</Para>
<Para>This method can only return up to 3,200 of a user's most recent Tweets. Native retweets of other statuses by the user is included in this total, regardless of whether include_rts is set to false when requesting this resource.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTimelines.swift" line="104">
<Name>getStatusesHomeTimelineWithCount(_:sinceID:maxID:trimUser:contributorDetails:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter32getStatusesHomeTimelineWithCountFS0_FTGSqSi_7sinceIDGSqSi_5maxIDGSqSi_8trimUserGSqSb_18contributorDetailsGSqSb_15includeEntitiesGSqSb_7successGSqFT8statusesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getStatusesHomeTimelineWithCount(count: Int?, sinceID: Int?, maxID: Int?, trimUser: Bool?, contributorDetails: Bool?, includeEntities: Bool?, success: ((statuses: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET statuses/home_timeline</Para>
</Abstract>
<Discussion>
<Para>Returns Tweets (*: tweets from people the user follows)</Para>
<Para>Returns a collection of the most recent Tweets and retweets posted by the authenticating user and the users they follow. The home timeline is central to how most users interact with the Twitter service.</Para>
<Para>Up to 800 Tweets are obtainable on the home timeline. It is more volatile for users that follow many users or follow users who tweet frequently.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterTimelines.swift" line="113">
<Name>getStatusesRetweetsOfMeWithCount(_:sinceID:maxID:trimUser:contributorDetails:includeEntities:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter32getStatusesRetweetsOfMeWithCountFS0_FTGSqSi_7sinceIDGSqSi_5maxIDGSqSi_8trimUserGSqSb_18contributorDetailsGSqSb_15includeEntitiesGSqSb_7successGSqFT8statusesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getStatusesRetweetsOfMeWithCount(count: Int?, sinceID: Int?, maxID: Int?, trimUser: Bool?, contributorDetails: Bool?, includeEntities: Bool?, success: ((statuses: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET statuses/retweets_of_me</Para>
</Abstract>
<Discussion>
<Para>Returns the most recent tweets authored by the authenticating user that have been retweeted by others. This timeline is a subset of the user's GET statuses/user_timeline. See Working with Timelines for instructions on traversing timelines.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterHelp.swift" line="37">
<Name>getHelpConfigurationWithSuccess(_:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter31getHelpConfigurationWithSuccessFS0_FTGSqFT6configGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getHelpConfigurationWithSuccess(success: ((config: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET help/configuration</Para>
</Abstract>
<Discussion>
<Para>Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutions, and t.co URL lengths.</Para>
<Para>It is recommended applications request this endpoint when they are loaded, but no more than once a day.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterHelp.swift" line="54">
<Name>getHelpLanguagesWithSuccess(_:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter27getHelpLanguagesWithSuccessFS0_FTGSqFT9languagesGSqGSaOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getHelpLanguagesWithSuccess(success: ((languages: [JSONValue]?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET help/languages</Para>
</Abstract>
<Discussion>
<Para>Returns the list of languages supported by Twitter along with their ISO 639-1 code. The ISO 639-1 code is the two letter value to use if you include lang with any of your requests.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterHelp.swift" line="71">
<Name>getHelpPrivacyWithSuccess(_:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter25getHelpPrivacyWithSuccessFS0_FTGSqFT7privacyGSqSS__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getHelpPrivacyWithSuccess(success: ((privacy: String?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET help/privacy</Para>
</Abstract>
<Discussion>
<Para>Returns Twitter's Privacy Policy.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterHelp.swift" line="88">
<Name>getHelpTermsOfServiceWithSuccess(_:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter32getHelpTermsOfServiceWithSuccessFS0_FTGSqFT3tosGSqSS__T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getHelpTermsOfServiceWithSuccess(success: ((tos: String?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET help/tos</Para>
</Abstract>
<Discussion>
<Para>Returns the Twitter Terms of Service in the requested format. These are not the same as the Developer Rules of the Road.</Para>
</Discussion>
</Function>
<Function column="17" file="/Users/jp/Projects/Swifter/Swifter/SwifterHelp.swift" line="115">
<Name>getRateLimitsForResources(_:success:failure:)</Name>
<USR>s:FC10SwifteriOS7Swifter25getRateLimitsForResourcesFS0_FTGSaSS_7successGSqFT15rateLimitStatusGSqGVSs10DictionarySSOS_4JSON___T__7failureGSqFT5errorCSo7NSError_T___T_</USR>
<Declaration>public func getRateLimitsForResources(resources: [String], success: ((rateLimitStatus: Dictionary&lt;String, JSONValue&gt;?) -&gt; Void)?, failure: FailureHandler?)</Declaration>
<Abstract>
<Para>GET application/rate_limit_status</Para>
</Abstract>
<Discussion>
<Para>Returns the current rate limits for methods belonging to the specified resource families.</Para>
<Para>Each 1.1 API resource belongs to a &quot;resource family&quot; which is indicated in its method documentation. You can typically determine a method's resource family from the first component of the path after the resource version.</Para>
<Para>This method responds with a map of methods belonging to the families specified by the resources parameter, the current remaining uses for each of those resources within the current rate limiting window, and its expiration time in epoch time. It also includes a rate_limit_context field that indicates the current access token or application-only authentication context.</Para>
<Para>You may also issue requests to this method without any parameters to receive a map of all rate limited GET methods. If your application only uses a few of methods, please explicitly provide a resources parameter with the specified resource families you work with.</Para>
<Para>When using app-only auth, this method's response indicates the app-only auth rate limiting context.</Para>
<Para>Read more about REST API Rate Limiting in v1.1 and review the limits.</Para>
</Discussion>
</Function>
</jazzy>
@segiddins
Copy link

Questions:

  1. Is each jazzy a class?
  2. Any demarcation of instance method vs. function vs. class method?
  3. What do enum and struct declarations look like?

Finally, it'd be really helpful to know what these things will look like for Obj-C -- it would be really nice for Jazzy to have an object for each entity, and that object would encapsulate the Declaration for both languages (that would make templating a lot simpler).

@segiddins
Copy link

@jpsim do the Functions not have an array of parameters?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment