Trait

com.danielasfregola.twitter4s.http.clients.rest.friendships

TwitterFriendshipClient

Related Doc: package friendships

Permalink

trait TwitterFriendshipClient extends RestClient with Configurations

Implements the available requests for the friendships resource.

Source
TwitterFriendshipClient.scala
Linear Supertypes
Configurations, RestClient, OAuthClient, RequestBuilding, TransformerPipelineSupport, TokenProvider, CommonClient, ActorContextExtractor, ActorSystemProvider, ExecutionContextProvider, JsonSupport, Json4sSupport, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TwitterFriendshipClient
  2. Configurations
  3. RestClient
  4. OAuthClient
  5. RequestBuilding
  6. TransformerPipelineSupport
  7. TokenProvider
  8. CommonClient
  9. ActorContextExtractor
  10. ActorSystemProvider
  11. ExecutionContextProvider
  12. JsonSupport
  13. Json4sSupport
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class OAuthRequestBuilder extends OAuthClient.RequestBuilder with BodyEncoder

    Permalink
    Definition Classes
    OAuthClient
  2. class RequestBuilder extends AnyRef

    Permalink
    Definition Classes
    RequestBuilding
  3. type RequestTransformer = (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    RequestBuilding
  4. implicit class WithTransformation[A] extends AnyRef

    Permalink
    Definition Classes
    TransformerPipelineSupport
  5. implicit class WithTransformerConcatenation[A, B] extends (A) ⇒ B

    Permalink
    Definition Classes
    TransformerPipelineSupport

Abstract Value Members

  1. abstract val accessToken: AccessToken

    Permalink
    Definition Classes
    TokenProvider
  2. abstract val consumerToken: ConsumerToken

    Permalink
    Definition Classes
    TokenProvider
  3. implicit abstract def system: ActorSystem

    Permalink
    Definition Classes
    ActorSystemProvider

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val Delete: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  5. val Get: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  6. val Head: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  7. val Options: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  8. val Patch: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  9. val Post: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  10. val Put: OAuthRequestBuilder

    Permalink
    Definition Classes
    OAuthClient → RequestBuilding
  11. lazy val accessTokenKey: String

    Permalink
    Definition Classes
    Configurations
  12. lazy val accessTokenSecret: String

    Permalink
    Definition Classes
    Configurations
  13. def addCredentials(credentials: HttpCredentials): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  14. def addHeader(headerName: String, headerValue: String): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  15. def addHeader(header: HttpHeader): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  16. def addHeaders(first: HttpHeader, more: HttpHeader*): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  17. val apiTwitterUrl: String

    Permalink
    Definition Classes
    Configurations
  18. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  19. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. def connection(implicit request: HttpRequest): Flow[HttpRequest, HttpResponse, Future[OutgoingConnection]]

    Permalink
    Attributes
    protected
    Definition Classes
    CommonClient
  21. lazy val consumerTokenKey: String

    Permalink
    Definition Classes
    Configurations
  22. lazy val consumerTokenSecret: String

    Permalink
    Definition Classes
    Configurations
  23. def disableDeviceNotificationsForUser(screen_name: String): Future[Relationship]

    Permalink

    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://dev.twitter.com/rest/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.

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

    Permalink

    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://dev.twitter.com/rest/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.

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

    Permalink

    Allows one to disable retweets from the specified user.

    Allows one to disable retweets from the specified user. For more information see https://dev.twitter.com/rest/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.

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

    Permalink

    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://dev.twitter.com/rest/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.

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

    Permalink

    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://dev.twitter.com/rest/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.

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

    Permalink

    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://dev.twitter.com/rest/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.

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

    Permalink

    Allows one to enable retweets from the specified user.

    Allows one to enable retweets from the specified user. For more information see https://dev.twitter.com/rest/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.

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

    Permalink

    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://dev.twitter.com/rest/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.

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

    Permalink
    Definition Classes
    AnyRef
  32. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  33. implicit val executionContext: ExecutionContext

    Permalink
    Definition Classes
    ActorContextExtractor → ExecutionContextProvider
  34. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  35. def followUser(screen_name: String, notify: Boolean = true): Future[User]

    Permalink

    Allows the authenticating users to follow the specified user.

    Allows the authenticating users to follow the specified user. For more information see https://dev.twitter.com/rest/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.

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

    Permalink

    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://dev.twitter.com/rest/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.

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

    Permalink
    Definition Classes
    AnyRef → Any
  38. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  39. implicit def header2AddHeader(header: HttpHeader): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  40. def incomingFriendshipIds(cursor: Long = 1): Future[UserIds]

    Permalink

    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://dev.twitter.com/rest/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.

  41. def incomingFriendshipStringifiedIds(cursor: Long = 1): Future[UserStringifiedIds]

    Permalink

    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://dev.twitter.com/rest/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.

  42. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  43. implicit lazy val json4sFormats: Formats

    Permalink
    Definition Classes
    JsonSupport
  44. implicit def json4sMarshaller[A <: AnyRef](implicit serialization: Serialization, formats: Formats, shouldWritePretty: ShouldWritePretty): ToEntityMarshaller[A]

    Permalink
    Definition Classes
    Json4sSupport
  45. implicit def json4sUnmarshaller[A](implicit arg0: Manifest[A], serialization: Serialization, formats: Formats): FromEntityUnmarshaller[A]

    Permalink
    Definition Classes
    Json4sSupport
  46. implicit val log: LoggingAdapter

    Permalink
    Definition Classes
    ActorContextExtractor
  47. def logRequest(logFun: (HttpRequest) ⇒ Unit): (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    RequestBuilding
  48. def logRequest(log: LoggingAdapter, level: LogLevel): (HttpRequest) ⇒ HttpRequest

    Permalink
    Definition Classes
    RequestBuilding
  49. def logRequest(implicit request: HttpRequest): HttpRequest

    Permalink
    Definition Classes
    CommonClient
  50. def logRequestResponse(requestStartTime: Long)(implicit request: HttpRequest): (HttpResponse) ⇒ HttpResponse

    Permalink
    Definition Classes
    CommonClient
  51. def logValue[T](logFun: (T) ⇒ Unit): (T) ⇒ T

    Permalink
    Definition Classes
    TransformerPipelineSupport
  52. def logValue[T](log: LoggingAdapter, level: LogLevel): (T) ⇒ T

    Permalink
    Definition Classes
    TransformerPipelineSupport
  53. def mapHeaders(f: (Seq[HttpHeader]) ⇒ Seq[HttpHeader]): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  54. implicit val materializer: ActorMaterializer

    Permalink
    Definition Classes
    ActorSystemProvider
  55. val mediaTwitterUrl: String

    Permalink
    Definition Classes
    Configurations
  56. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  57. def noRetweetsUserIds(): Future[Seq[Long]]

    Permalink

    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://dev.twitter.com/rest/reference/get/friendships/no_retweets/ids.

    returns

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

  58. def noRetweetsUserStringifiedIds(): Future[Seq[String]]

    Permalink

    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://dev.twitter.com/rest/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.

  59. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  60. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  61. lazy val oauthProvider: OAuth2Provider

    Permalink
    Attributes
    protected
    Definition Classes
    OAuthClient
  62. def outgoingFriendshipIds(cursor: Long = 1): Future[UserIds]

    Permalink

    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://dev.twitter.com/rest/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.

  63. def outgoingFriendshipStringifiedIds(cursor: Long = 1): Future[UserStringifiedIds]

    Permalink

    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://dev.twitter.com/rest/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.

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

    Permalink

    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://dev.twitter.com/rest/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.

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

    Permalink

    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://dev.twitter.com/rest/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.

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

    Permalink

    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://dev.twitter.com/rest/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.

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

    Permalink

    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://dev.twitter.com/rest/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.

  68. def removeHeader(clazz: Class[_]): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  69. def removeHeader[T <: HttpHeader](implicit arg0: ClassTag[T]): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  70. def removeHeader(headerName: String): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  71. def removeHeaders(names: String*): RequestTransformer

    Permalink
    Definition Classes
    RequestBuilding
  72. def sendAndReceive[T](request: HttpRequest, f: (HttpResponse) ⇒ Future[T]): Future[T]

    Permalink
    Attributes
    protected
    Definition Classes
    RestClient
  73. def sendReceiveAs[T](httpRequest: HttpRequest)(implicit arg0: Manifest[T]): Future[T]

    Permalink
    Definition Classes
    RestClient
  74. implicit val serialization: Serialization.type

    Permalink
    Definition Classes
    JsonSupport
  75. val siteStreamingTwitterUrl: String

    Permalink
    Definition Classes
    Configurations
  76. val statusStreamingTwitterUrl: String

    Permalink
    Definition Classes
    Configurations
  77. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  78. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  79. val twitterVersion: String

    Permalink
    Definition Classes
    Configurations
  80. def unfollowUser(screen_name: String): Future[User]

    Permalink

    Allows the authenticating users to unfollow the specified user.

    Allows the authenticating users to unfollow the specified user. For more information see https://dev.twitter.com/rest/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.

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

    Permalink

    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://dev.twitter.com/rest/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.

  82. def unmarshal[T](requestStartTime: Long, f: (HttpResponse) ⇒ Future[T])(implicit request: HttpRequest, response: HttpResponse): Future[T]

    Permalink
    Attributes
    protected
    Definition Classes
    CommonClient
  83. val userStreamingTwitterUrl: String

    Permalink
    Definition Classes
    Configurations
  84. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  87. val withLogRequest: Boolean

    Permalink
    Definition Classes
    RestClientCommonClient
  88. val withLogRequestResponse: Boolean

    Permalink
    Definition Classes
    RestClientCommonClient
  89. def withOAuthHeader: (HttpRequest) ⇒ Future[HttpRequest]

    Permalink
    Definition Classes
    OAuthClient
  90. def withSimpleOAuthHeader: (HttpRequest) ⇒ Future[HttpRequest]

    Permalink
    Definition Classes
    OAuthClient

Deprecated Value Members

  1. def getIncomingFriendshipIds(cursor: Long = 1): Future[UserIds]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use incomingFriendshipIds instead

  2. def getIncomingFriendshipStringifiedIds(cursor: Long = 1): Future[UserStringifiedIds]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use incomingFriendshipStringifiedIds instead

  3. def getNoRetweetsUserIds(): Future[Seq[Long]]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use noRetweetsUserIds instead

  4. def getNoRetweetsUserStringifiedIds(): Future[Seq[String]]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use noRetweetsUserStringifiedIds instead

  5. def getOutgoingFriendshipIds(cursor: Long = 1): Future[UserIds]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use outgoingFriendshipIds instead

  6. def getOutgoingFriendshipStringifiedIds(cursor: Long = 1): Future[UserStringifiedIds]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use outgoingFriendshipStringifiedIds instead

  7. def getRelationshipBetweenUserIds(source_id: Long, target_id: Long): Future[Relationship]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use relationshipBetweenUserIds instead

  8. def getRelationshipBetweenUsers(source_screen_name: String, target_screen_name: String): Future[Relationship]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use relationshipBetweenUsers instead

  9. def getRelationshipsWithUserIds(user_ids: Long*): Future[Seq[LookupRelationship]]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use relationshipsWithUserIds instead

  10. def getRelationshipsWithUsers(screen_names: String*): Future[Seq[LookupRelationship]]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2) use relationshipsWithUsers instead

Inherited from Configurations

Inherited from RestClient

Inherited from OAuthClient

Inherited from RequestBuilding

Inherited from TransformerPipelineSupport

Inherited from TokenProvider

Inherited from CommonClient

Inherited from ActorContextExtractor

Inherited from ActorSystemProvider

Inherited from ExecutionContextProvider

Inherited from JsonSupport

Inherited from Json4sSupport

Inherited from AnyRef

Inherited from Any

Ungrouped