twitter4s.api

HelpResources

trait HelpResources extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
HelpResourcesImpl
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HelpResources
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def getAPIConfiguration: TwitterAPIConfiguration

    Returns the current configuration used by Twitter including twitter.

    Returns the current configuration used by Twitter including twitter.com slugs which are not usernames, maximum photo resolutons, and t.co URL lengths.
    It is recommended applications request this endpoint when they are loaded, but no more than once a day.
    This method calls twitter4j.Twitter.getAPIConfiguration
    getAPIConfiguration calls https://api.twitter.com/1.1/help/configuration.json

    returns

    configuration

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    twitter4j.TwitterException

    when Twitter service or network is unavailable

    See also

    GET help/configuration | Twitter Developers

  2. abstract def getLanguages: ResponseList[Language]

    Returns the list of languages supported by Twitter along with their ISO 639-1 code.

    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.
    This method calls twitter4j.Twitter.getLanguages
    getLoanguages calls https://api.twitter.com/1.1/help/languages.json

    returns

    list of languages supported by Twitter

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    twitter4j.TwitterException

    when Twitter service or network is unavailable

    See also

    GET help/languages | Twitter Developers

  3. abstract def getPrivacyPolicy: String

    Returns Twitter's Privacy Policy.

    Returns Twitter's Privacy Policy.
    This method calls twitter4j.Twitter.getPrivacyPolicy.
    getPrivacyPolicy calls https://api.twitter.com/1.1/help/privacy.json

    returns

    privacy policy

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    twitter4j.TwitterException

    when Twitter service or network is unavailable

    See also

    GET help/privacy | Twitter Developers

  4. abstract def getRateLimitStatus(resources: String*): Map[String, twitter4j.RateLimitStatus]

    Returns the current rate limits for methods belonging to the specified resource families.

    Returns the current rate limits for methods belonging to the specified resource families.
    Each 1.1 API resource belongs to a "resource family" 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.
    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 context.
    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.
    Read more about REST API Rate Limiting in v1.1 and review the limits.
    As of Nov 4th 2012, supported resource names are as follows: "trends","application","users","saved_searches","geo","direct_messages","blocks","favorites","statuses","followers","help","friends","search","friendships","account","lists"
    This method calls twitter4j.Twitter.getRateLimitStatus.
    This method calls http://api.twitter.com/1.1/application/rate_limit_status.json

    returns

    map of rate limit statuses. the key of map is resource.

    Since

    Twitter4S 2.0.0

    Exceptions thrown
    twitter4j.TwitterException

    when Twitter service or network is unavailable

    See also

    GET application/rate_limit_status

  5. abstract def getTermsOfService: String

    Returns Twitter's' Terms of Service.

    Returns Twitter's' Terms of Service.
    This method calls twitter4j.Twitter.getTermsOfService.
    getTermsOfService calls https://api.twitter.com/1.1/help/tos.json

    returns

    Terms of Service

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    twitter4j.TwitterException

    when Twitter service or network is unavailable

    See also

    GET help/tos | Twitter Developers

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  10. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  12. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. final def notify(): Unit

    Definition Classes
    AnyRef

  16. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  18. def toString(): String

    Definition Classes
    AnyRef → Any

  19. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  20. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped