Packages

trait TwitterFriendClient extends AnyRef

Implements the available requests for the friends resource.

Source
TwitterFriendClient.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TwitterFriendClient
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract val restClient: RestClient
    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. def friendIdsForUser(screen_name: String, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserIds]]

    Returns a cursored collection of user IDs for every user the specified user is following (otherwise known as their “friends”).

    Returns a cursored collection of user IDs for every user the specified user is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids.

    screen_name

    : The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.

    cursor

    : By default it is -1, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it is None. Returns results with an ID less than (that is, older than) or equal to the specified ID.

    count

    : By default it is 5000. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.

    returns

    : The cursored representation of the user ids the specified user is following.

  10. def friendIdsForUserId(user_id: Long, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserIds]]

    Returns a cursored collection of user IDs for every user the specified user id is following (otherwise known as their “friends”).

    Returns a cursored collection of user IDs for every user the specified user id is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids.

    user_id

    : The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.

    cursor

    : By default it is -1, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it is None. Returns results with an ID less than (that is, older than) or equal to the specified ID.

    count

    : By default it is 5000. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.

    returns

    : The cursored representation of the user ids the specified user id is following.

  11. def friendStringifiedIdsForUser(screen_name: String, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserStringifiedIds]]

    Returns a cursored collection of user stringified IDs for every user the specified user is following (otherwise known as their “friends”).

    Returns a cursored collection of user stringified IDs for every user the specified user is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids.

    screen_name

    : The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.

    cursor

    : By default it is -1, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it is None. Returns results with an ID less than (that is, older than) or equal to the specified ID.

    count

    : By default it is 5000. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.

    returns

    : The cursored representation of the user stringified ids the specified user is following.

  12. def friendStringifiedIdsForUserId(user_id: Long, cursor: Long = -1, count: Int = 5000): Future[RatedData[UserStringifiedIds]]

    Returns a cursored collection of user stringified IDs for every user the specified user id is following (otherwise known as their “friends”).

    Returns a cursored collection of user stringified IDs for every user the specified user id is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-ids.

    user_id

    : The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.

    cursor

    : By default it is -1, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it is None. Returns results with an ID less than (that is, older than) or equal to the specified ID.

    count

    : By default it is 5000. Specifies the number of IDs attempt retrieval of, up to a maximum of 5,000 per distinct request. The value of count is best thought of as a limit to the number of results to return. When using the count parameter with this method, it is wise to use a consistent count value across all requests to the same user’s collection. Usage of this parameter is encouraged in environments where all 5,000 IDs constitutes too large of a response.

    returns

    : The cursored representation of the user stringified ids the specified user id is following.

  13. def friendsForUser(screen_name: String, cursor: Long = -1, count: Int = 20, skip_status: Boolean = false, include_user_entities: Boolean = true): Future[RatedData[Users]]

    Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their “friends”).

    Returns a cursored collection of user objects for every user the specified user is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-list.

    screen_name

    : The screen name of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.

    cursor

    : By default it is -1, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it is None. Returns results with an ID less than (that is, older than) or equal to the specified ID.

    count

    : By default it is 20. The number of users to return per page, up to a maximum of 200.

    skip_status

    : By default it is false. When set to either true statuses will not be included in the returned user objects.

    include_user_entities

    : By default it is true. The user object parameters node will not be included when set to false.

    returns

    : The cursored representation of the users the specified user is following.

  14. def friendsForUserId(user_id: Long, cursor: Long = -1, count: Int = 20, skip_status: Boolean = false, include_user_entities: Boolean = true): Future[RatedData[Users]]

    Returns a cursored collection of user objects for every user the specified user id is following (otherwise known as their “friends”).

    Returns a cursored collection of user objects for every user the specified user id is following (otherwise known as their “friends”). For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friends-list.

    user_id

    : The ID of the user for whom to return results for. Helpful for disambiguating when a valid user ID is also a valid screen name.

    cursor

    : By default it is -1, which is the first “page”. Causes the list of blocked users to be broken into pages of no more than 5000 IDs at a time. The number of IDs returned is not guaranteed to be 5000 as suspended users are filtered out after connections are queried. * @param max_id : Optional, by default it is None. Returns results with an ID less than (that is, older than) or equal to the specified ID.

    count

    : By default it is 20. The number of users to return per page, up to a maximum of 200.

    skip_status

    : By default it is false. When set to either true statuses will not be included in the returned user objects.

    include_user_entities

    : By default it is true. The user object parameters node will not be included when set to false.

    returns

    : The cursored representation of the users the specified user id is following.

  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped