Package com.twitter.clientlib.api

Class TweetsApi.APItweetsRecentSearchRequest

  • Enclosing class:
    TweetsApi
    public class TweetsApi.APItweetsRecentSearchRequest
extends Object

    • Method Detail

      • startTime

        public TweetsApi.APItweetsRecentSearchRequest startTime​(OffsetDateTime startTime)
        Set startTime
        Parameters:
        startTime - YYYY-MM-DDTHH:mm:ssZ. The oldest UTC timestamp from which the Tweets will be provided. Timestamp is in second granularity and is inclusive (i.e. 12:00:01 includes the first second of the minute). (optional)
        Returns:
        APItweetsRecentSearchRequest

      • endTime

        public TweetsApi.APItweetsRecentSearchRequest endTime​(OffsetDateTime endTime)
        Set endTime
        Parameters:
        endTime - YYYY-MM-DDTHH:mm:ssZ. The newest, most recent UTC timestamp to which the Tweets will be provided. Timestamp is in second granularity and is exclusive (i.e. 12:00:01 excludes the first second of the minute). (optional)
        Returns:
        APItweetsRecentSearchRequest

      • sinceId

        public TweetsApi.APItweetsRecentSearchRequest sinceId​(String sinceId)
        Set sinceId
        Parameters:
        sinceId - Returns results with a Tweet ID greater than (that is, more recent than) the specified ID. (optional)
        Returns:
        APItweetsRecentSearchRequest

      • untilId

        public TweetsApi.APItweetsRecentSearchRequest untilId​(String untilId)
        Set untilId
        Parameters:
        untilId - Returns results with a Tweet ID less than (that is, older than) the specified ID. (optional)
        Returns:
        APItweetsRecentSearchRequest

      • maxResults

        public TweetsApi.APItweetsRecentSearchRequest maxResults​(Integer maxResults)
        Set maxResults
        Parameters:
        maxResults - The maximum number of search results to be returned by a request. (optional, default to 10)
        Returns:
        APItweetsRecentSearchRequest

      • nextToken

        public TweetsApi.APItweetsRecentSearchRequest nextToken​(String nextToken)
        Set nextToken
        Parameters:
        nextToken - This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. (optional)
        Returns:
        APItweetsRecentSearchRequest

      • paginationToken

        public TweetsApi.APItweetsRecentSearchRequest paginationToken​(String paginationToken)
        Set paginationToken
        Parameters:
        paginationToken - This parameter is used to get the next 'page' of results. The value used with the parameter is pulled directly from the response provided by the API, and should not be modified. (optional)
        Returns:
        APItweetsRecentSearchRequest

      • tweetFields

        public TweetsApi.APItweetsRecentSearchRequest tweetFields​(Set<String> tweetFields)
        Set tweetFields
        Parameters:
        tweetFields - A comma separated list of Tweet fields to display. (optional)
        Returns:
        APItweetsRecentSearchRequest

      • mediaFields

        public TweetsApi.APItweetsRecentSearchRequest mediaFields​(Set<String> mediaFields)
        Set mediaFields
        Parameters:
        mediaFields - A comma separated list of Media fields to display. (optional)
        Returns:
        APItweetsRecentSearchRequest

      • pollFields

        public TweetsApi.APItweetsRecentSearchRequest pollFields​(Set<String> pollFields)
        Set pollFields
        Parameters:
        pollFields - A comma separated list of Poll fields to display. (optional)
        Returns:
        APItweetsRecentSearchRequest

      • userFields

        public TweetsApi.APItweetsRecentSearchRequest userFields​(Set<String> userFields)
        Set userFields
        Parameters:
        userFields - A comma separated list of User fields to display. (optional)
        Returns:
        APItweetsRecentSearchRequest

      • placeFields

        public TweetsApi.APItweetsRecentSearchRequest placeFields​(Set<String> placeFields)
        Set placeFields
        Parameters:
        placeFields - A comma separated list of Place fields to display. (optional)
        Returns:
        APItweetsRecentSearchRequest

      • buildCall

        public okhttp3.Call buildCall​(ApiCallback _callback)
                       throws ApiException
        Build call for tweetsRecentSearch
        Parameters:
        _callback - ApiCallback API callback
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 The request has succeeded. -
        0 The request has failed. -

      • execute

        public Get2TweetsSearchRecentResponse execute()
                                       throws ApiException
        Execute tweetsRecentSearch request
        Returns:
        Get2TweetsSearchRecentResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 The request has succeeded. -
        0 The request has failed. -

      • executeWithHttpInfo

        public ApiResponse<Get2TweetsSearchRecentResponse> executeWithHttpInfo()
                                                                throws ApiException
        Execute tweetsRecentSearch request with HTTP info returned
        Returns:
        ApiResponse<Get2TweetsSearchRecentResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 The request has succeeded. -
        0 The request has failed. -

      • executeAsync

        public okhttp3.Call executeAsync​(ApiCallback<Get2TweetsSearchRecentResponse> _callback)
                          throws ApiException
        Execute tweetsRecentSearch request (asynchronously)
        Parameters:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 The request has succeeded. -
        0 The request has failed. -