twitter4s.api

FriendsFollowersResources

trait FriendsFollowersResources extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FriendsFollowersResources
  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 createFriendship(specificUser: SpecificInfo, follow: Boolean = null): User

    Allows the authenticating users to follow the user specified in the ID parameter.

    Allows the authenticating users to follow the user specified in the ID parameter.
    Returns the befriended user in the requested format when successful. Returns a string describing the failure condition when unsuccessful. If you are already friends with the user an HTTP 403 will be returned.
    This method calls twitter4j.Twitter.createFriendship.
    createFriendship calls http://api.twitter.com/1.1/friendships/create/[id].json
    Note1: You must set parameter screenName or userId at least.
    Note2: Parameter userId is taken priority over screenName.

    specificUser

    (required) the user specific information(screen name or ID) to be befriended.

    follow

    (optional) Enable notifications for the target user in addition to becoming friends.

    returns

    the befriended user

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    IllegalArgumentException

    when specificUser is set null.

    TwitterException

    when Twitter service or network is unavailable

    See also

    POST friendships/create | Twitter Developers

  2. abstract def destroyFriendship(specificUser: SpecificInfo): User

    Allows the authenticating users to unfollow the user specified in the ID parameter.

    Allows the authenticating users to unfollow the user specified in the ID parameter.
    Returns the unfollowed user in the requested format when successful. Returns a string describing the failure condition when unsuccessful.
    This method calls twitter4j.Twitter.destroyFriendship.
    destroyFriendship calls http://api.twitter.com/1.1/friendships/destroy/[id].json
    Note1: You must set parameter screenName or userId at least.
    Note2: Parameter userId is taken priority over screenName.

    specificUser

    the user specific information (screen name or ID) for whom to request a list of friends

    returns

    User

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    IllegalArgumentException

    when specificUser is set null.

    TwitterException

    when Twitter service or network is unavailable

    See also

    POST friendships/destroy | Twitter Developers

  3. abstract def getFollowersIDs(cursor: Long, specificUser: SpecificInfo = null): IDs

    Returns an array of numeric IDs for every user the specified user is followed by.

    Returns an array of numeric IDs for every user the specified user is followed by.
    This method calls twitter4j.Twitter.getFollowersIDs.
    getFollowersIDs calls http://api.twitter.com/1.1/followers/ids.json
    Note: Parameter userId is taken priority over screenName.

    cursor

    (required) Causes the list of connections 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 filterd out after connections are queried.
    To begin paging provide a value of -1 as the cursor. The response from the API will include a previous_cursor and next_cursor to allow paging back and forth.

    specificUser

    (optional) Specifies the user (screen name or ID) for whom to return the followers list.

    returns

    The ID or screen_name of the user to retrieve the friends ID list for.

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    GET followers/ids | Twitter Developers

  4. abstract def getFollowersList(specificUser: SpecificInfo, cursor: Long): PagableResponseList[twitter4j.User]

    Returns a cursored collection of user objects for users following the specified user.

    Returns a cursored collection of user objects for users following the specified user.
    At this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 20 users and multiple "pages" of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information.
    This method calls http://api.twitter.com/1.1/friends/list.json
    This method calls twitter4j.Twitter.getFollowersList

    specificUser

    The ID or screen name of the user for whom to return results for.

    cursor

    Causes the results to be broken into pages of no more than 20 records at a time.

    returns

    list of followers

    Since

    Twitter4S 2.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    GET followers/list | Twitter Developers

  5. abstract def getFriendsIDs(cursor: Long, specificUser: SpecificInfo = null): IDs

    Returns an array of numeric IDs for every user the authenticating user is following.

    Returns an array of numeric IDs for every user the authenticating user is following.
    This method calls twitter4j.Twitter.getFriendsIDs.
    getFriendsIDs calls http://api.twitter.com/1.1/friends/ids.json
    Note: Parameter userId is taken priority over screenName.

    cursor

    (required) Causes the list of connections 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 filterd out after connections are queried.
    To begin paging provide a value of -1 as the cursor. The response from the API will include a previous_cursor and next_cursor to allow paging back and forth.

    specificUser

    (optional) Specifies the user (screen name or ID) for whom to return the friends list.

    returns

    an array of numeric IDs for every user the authenticating user is following

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    GET friends/ids | Twitter Developers

  6. abstract def getFriendsList(specificUser: SpecificInfo, cursor: Long): PagableResponseList[twitter4j.User]

    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").
    At this time, results are ordered with the most recent following first — however, this ordering is subject to unannounced change and eventual consistency issues. Results are given in groups of 20 users and multiple "pages" of results can be navigated through using the next_cursor value in subsequent requests. See Using cursors to navigate collections for more information.
    This method calls http://api.twitter.com/1.1/friends/list.json
    This method calls twitter4j.Twitter.getFriendsList

    specificUser

    The ID or screen name of the user for whom to return results for.

    cursor

    Causes the results to be broken into pages of no more than 20 records at a time.

    returns

    list of friends

    Since

    Twitter4S 2.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    GET friends/list | Twitter Developers

  7. abstract def getIncomingFriendships(cursor: Long): IDs

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

    Returns an array of numeric IDs for every user who has a pending request to follow the authenticating user.
    This method calls twitter4j.Twitter.getIncomingFriendships.
    getIncomingFriendships calls http://api.twitter.com/1.1/friendships/incoming.json

    cursor

    Breaks the results into pages. A single page contains 5000 identifiers. Provide a value of -1 to begin paging.

    returns

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

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    GET friendships/incoming | Twitter Developers

  8. abstract def getOutgoingFriendships(cursor: Long): IDs

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

    Returns an array of numeric IDs for every protected user for whom the authenticating user has a pending follow request.
    This method calls twitter4j.Twitter.getOutgoingFriendships.
    This method calls http://api.twitter.com/1.1/friendships/outgoing.json

    cursor

    Breaks the results into pages. A single page contains 5000 identifiers. Provide a value of -1 to begin paging.

    returns

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

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    GET friendships/outgoing | Twitter Developers

  9. abstract def lookupFriendships(specificUsers: SpecificInfo): ResponseList[Friendship]

    Returns the relationship of the authenticating user to the specified users.

    Returns the relationship of the authenticating user to the specified users.
    This method has not been finalized and the interface is subject to change in incompatible ways.
    This method calls twitter4j.Twitter.lookupFriendships.
    lookupFriendships calls http://api.twitter.com/1.1/friendships/lookup.json
    Note1: You must set screenNames or ids at least.
    Note2: Parameter ids is taken priority over screenNames.

    specificUsers

    (required) array of user specific informations(screen names or ids) to lookup

    returns

    list of Relationships

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    #newtwitter and the API - Twitter API Announcements | Google Group

  10. abstract def showFriendship(sourceSpecificUser: SpecificInfo, targetSpecificUser: SpecificInfo): Relationship

    Returns detailed information about the relationship between two users.

    Returns detailed information about the relationship between two users.
    This method calls twitter4j.Twitter.showFriendship
    showFriendship calls http://api.twitter.com/1.1/friendships/show.json
    Note1: You must set source and target ScreenName or source and target Id at least combination
    Note2: Id is taken priority over ScreenName.

    sourceSpecificUser

    (required) the source user specific information(screen name or ID)

    targetSpecificUser

    (required) the target user specific information(screen name or ID)

    returns

    Relationship

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    IllegalArgumentException

    when same information combination on source and target can not create.

    TwitterException

    when Twitter service or network is unavailable

    See also

    GET friendships/show | Twitter Developers

  11. abstract def updateFriendship(specificUser: SpecificInfo, enableDeviceNotification: Boolean, retweets: Boolean): Relationship

    Allows you to enable or disable retweets and device notifications from the specified user.

    Allows you to enable or disable retweets and device notifications from the specified user.
    This method has not been finalized and the interface is subject to change in incompatible ways.
    This method calls twitter4j.Twitter.lookupFriendships.
    lookupFriendships calls http://api.twitter.com/1.1/friendships/update.json
    Note1: You must set screenName or id at least.
    Note2: Parameter id is taken priority over screenName.

    specificUser

    (required) user specific information(screen name or ID) to update

    enableDeviceNotification

    (required) set true to enable device notification

    retweets

    (required) set true to enable retweets

    returns

    Relationship

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    IllegalArgumentException

    when specificUser is set null.

    TwitterException

    when Twitter service or network is unavailable

    See also

    #newtwitter and the API - Twitter API Announcements | Google Group

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