Packages

trait TwitterFriendshipClient extends AnyRef

Implements the available requests for the friendships resource.

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

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. def disableDeviceNotificationsForUser(screen_name: String): Future[Relationship]

    Allows one to disable device notifications from the specified user.

    Allows one to disable device notifications from the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.

    screen_name

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

    returns

    : The user representation of the target user.

  7. def disableDeviceNotificationsForUserId(user_id: Long): Future[Relationship]

    Allows one to disable device notifications from the specified user id.

    Allows one to disable device notifications from the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.

    user_id

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

    returns

    : The user representation of the target user.

  8. def disableRetweetsNotificationsForUser(screen_name: String): Future[Relationship]

    Allows one to disable retweets from the specified user.

    Allows one to disable retweets from the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.

    screen_name

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

    returns

    : The user representation of the target user.

  9. def disableRetweetsNotificationsForUserId(user_id: Long): Future[Relationship]

    Allows one to disable retweets from the specified user id.

    Allows one to disable retweets from the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.

    user_id

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

    returns

    : The user representation of the target user.

  10. def enableDeviceNotificationsForUser(screen_name: String): Future[Relationship]

    Allows one to enable device notifications from the specified user.

    Allows one to enable device notifications from the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.

    screen_name

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

    returns

    : The user representation of the target user.

  11. def enableDeviceNotificationsForUserId(user_id: Long): Future[Relationship]

    Allows one to enable device notifications from the specified user id.

    Allows one to enable device notifications from the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.

    user_id

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

    returns

    : The user representation of the target user.

  12. def enableRetweetsNotificationsForUser(screen_name: String): Future[Relationship]

    Allows one to enable retweets from the specified user.

    Allows one to enable retweets from the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.

    screen_name

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

    returns

    : The user representation of the target user.

  13. def enableRetweetsNotificationsForUserId(user_id: Long): Future[Relationship]

    Allows one to enable retweets from the specified user id.

    Allows one to enable retweets from the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-update.

    user_id

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

    returns

    : The user representation of the target user.

  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def followUser(screen_name: String, notify: Boolean = true): Future[User]

    Allows the authenticating users to follow the specified user.

    Allows the authenticating users to follow the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create.

    screen_name

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

    notify

    : By default it is true. Enable notifications for the target user.

    returns

    : The user representation of the target user.

  17. def followUserId(user_id: Long, notify: Boolean = true): Future[User]

    Allows the authenticating users to follow the specified user id.

    Allows the authenticating users to follow the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-create.

    user_id

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

    notify

    : By default it is true. Enable notifications for the target user.

    returns

    : The user representation of the target user.

  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def incomingFriendshipIds(cursor: Long = -1): Future[RatedData[UserIds]]

    Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user.

    Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming.

    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.

    returns

    : The sequence of the user ids that have a pending request to follow the authenticating user.

  21. def incomingFriendshipStringifiedIds(cursor: Long = -1): Future[RatedData[UserStringifiedIds]]

    Returns a collection of numeric stringified IDs for every user who has a pending request to follow the authenticating user.

    Returns a collection of numeric stringified IDs for every user who has a pending request to follow the authenticating user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-incoming.

    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.

    returns

    : The sequence of the user stringified ids that have a pending request to follow the authenticating user.

  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def noRetweetsUserIds(): Future[RatedData[Seq[Long]]]

    Returns a collection of user ids that the currently authenticated user does not want to receive retweets from.

    Returns a collection of user ids that the currently authenticated user does not want to receive retweets from. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-no_retweets-ids.

    returns

    : The sequence of user ids the currently authenticated user does not want to receive retweets from.

  25. def noRetweetsUserStringifiedIds(): Future[RatedData[Seq[String]]]

    Returns a collection of user stringified ids that the currently authenticated user does not want to receive retweets from.

    Returns a collection of user stringified ids that the currently authenticated user does not want to receive retweets from. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-no_retweets-ids.

    returns

    : The sequence of the user stringified ids the currently authenticated user does not want to receive retweets from.

  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def outgoingFriendshipIds(cursor: Long = -1): Future[RatedData[UserIds]]

    Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request.

    Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing.

    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.

    returns

    : The sequence of the user ids that have a pending follow request from the authenticating user.

  29. def outgoingFriendshipStringifiedIds(cursor: Long = -1): Future[RatedData[UserStringifiedIds]]

    Returns a collection of numeric stringified IDs for every protected user for whom the authenticating user has a pending follow request.

    Returns a collection of numeric stringified IDs for every protected user for whom the authenticating user has a pending follow request. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-outgoing.

    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.

    returns

    : The sequence of the user stringified ids that have a pending follow request from the authenticating user.

  30. def relationshipBetweenUserIds(source_id: Long, target_id: Long): Future[RatedData[Relationship]]

    Returns detailed information about the relationship between two arbitrary users ids.

    Returns detailed information about the relationship between two arbitrary users ids. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show.

    source_id

    : The user id of the subject user.

    target_id

    : The user id of the target user.

    returns

    : The representation of the relationship between the two users.

  31. def relationshipBetweenUsers(source_screen_name: String, target_screen_name: String): Future[RatedData[Relationship]]

    Returns detailed information about the relationship between two arbitrary users.

    Returns detailed information about the relationship between two arbitrary users. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-show.

    source_screen_name

    : The screen name of the subject user.

    target_screen_name

    : The screen name of the target user.

    returns

    : The representation of the relationship between the two users.

  32. def relationshipsWithUserIds(user_ids: Long*): Future[RatedData[Seq[LookupRelationship]]]

    Returns the relationships of the authenticating user of up to 100 user ids.

    Returns the relationships of the authenticating user of up to 100 user ids. Values for connections can be: following, following_requested, followed_by, none, blocking, muting. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup.

    user_ids

    : The list of user ids. At least 1 user id needs to be provided. Up to 100 are allowed in a single request. Helpful for disambiguating when a valid user ID is also a valid screen name.

    returns

    : The sequence of the lookup relationships.

  33. def relationshipsWithUsers(screen_names: String*): Future[RatedData[Seq[LookupRelationship]]]

    Returns the relationships of the authenticating user of up to 100 user screen names.

    Returns the relationships of the authenticating user of up to 100 user screen names. Values for connections can be: following, following_requested, followed_by, none, blocking, muting. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/get-friendships-lookup.

    screen_names

    : The list of screen names. At least 1 screen name needs to be provided. Up to 100 are allowed in a single request. Helpful for disambiguating when a valid user ID is also a valid screen name.

    returns

    : The sequence of the lookup relationships.

  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. def unfollowUser(screen_name: String): Future[User]

    Allows the authenticating users to unfollow the specified user.

    Allows the authenticating users to unfollow the specified user. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.

    screen_name

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

    returns

    : The user representation of the target user.

  37. def unfollowUserId(user_id: Long): Future[User]

    Allows the authenticating users to unfollow the specified user id.

    Allows the authenticating users to unfollow the specified user id. For more information see https://developer.twitter.com/en/docs/accounts-and-users/follow-search-get-users/api-reference/post-friendships-destroy.

    user_id

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

    returns

    : The user representation of the target user.

  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped