trait TwitterFriendshipClient extends AnyRef
Implements the available requests for the friendships
resource.
- Alphabetic
- By Inheritance
- TwitterFriendshipClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
- abstract val restClient: RestClient
- Attributes
- protected
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- 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.
- 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.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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.
- 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.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- 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.
- 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.
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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.
- 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.
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()