twitter4s.api

ListsResources

trait ListsResources extends AnyRef

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ListsResources
  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 createUserList(listName: String, isPublicList: Boolean, description: String): UserList

    Creates a new list for the authenticated user.

    Creates a new list for the authenticated user. Accounts are limited to 20 lists.
    This method calls twitter4j.Twitter.createUserList.
    createUserList calls http://api.twitter.com/1.1/lists/create.json

    listName

    The name of the list you are creating. Required.

    isPublicList

    set true if you wish to make a public list

    description

    The description of the list you are creating. Optional.

    returns

    the list that was created

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    twitter4j.TwitterException

    when Twitter service or network is unavailable, or the authenticated user already has 20 lists(TwitterException.getStatusCode() == 403).

    See also

    POST lists/create | Twitter Developers

  2. abstract def createUserListMember(listSpecificInfo: SpecificInfo, userId: Long): UserList

    Adds a member to a list.

    Adds a member to a list. The authenticated user must own the list to be able to add members to it. Lists are limited to having 500 members.
    This method calls twitter4j.Twitter.addUserListMember
    This method calls http://api.twitter.com/1.1/lists/members/create.json

    listSpecificInfo

    The list specific information(set list id or set screen name or user id and slug)

    userId

    The id of the user to add as a member of the list.

    returns

    the updated list

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    POST lists/members/create | Twitter Developers

  3. abstract def createUserListMembers(listSpecificInfo: SpecificInfo, specificUsers: SpecificInfo): UserList

    Adds multiple members to a list, by specifying a comma-separated list of member ids or screen names.

    Adds multiple members to a list, by specifying a comma-separated list of member ids or screen names. The authenticated user must own the list to be able to add members to it. Lists are limited to having 500 members, and you are limited to adding up to 100 members to a list at a time with this method.
    This method calls twitter4j.Twitter.addUserListMembers.
    addUserListMembers calls http://api.twitter.com/1.1/lists/members/create_all.json
    Note1: You must set userIds or screenNames at least.
    Note2: Parameter userIds is taken priority over screenNames.

    listSpecificInfo

    The list specific information(set list id or set screen name or user id and slug)

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    POST lists/members/create_all | Twitter Developers

  4. abstract def createUserListSubscription(listSpecificInfo: SpecificInfo): UserList

    Make the authenticated user follow the specified list.

    Make the authenticated user follow the specified list.
    This method calls twitter4j.Twitter.createUserListSubscription.
    createUserListSubscribers calls http://api.twitter.com/1.1/list/subscribers/create.json

    listSpecificInfo

    The list specific information(set list id or set screen name or user id and slug)

    returns

    the updated list

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    POST lists/subscribers/create | Twitter Developers

  5. abstract def destroyUserList(listSpecificInfo: SpecificInfo): UserList

    Deletes the specified list.

    Deletes the specified list. Must be owned by the authenticated user.
    This method calls twitter4j.Twitter.destroyUserList.
    destroyUserList calls http://api.twitter.com/1.1/lists/destroy.json

    listSpecificInfo

    (required) the user list specific information(list id or [screen name or ID] and list slug)

    returns

    the deleted list

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    POST lists/destroy | Twitter Developers

  6. abstract def destroyUserListMember(listSpecificInfo: SpecificInfo, userId: Long): UserList

    Removes the specified member from the list.

    Removes the specified member from the list. The authenticated user must be the list's owner to remove members from the list.
    This method calls twitter4j.Twitter.destroyUserListMember.
    deleteUserListMember calls http://api.twitter.com/1.1/lists/members/destroy.json

    listSpecificInfo

    The list specific information(set list id or set screen name or user id and slug)

    userId

    The screen name of the member you wish to remove from the list.

    returns

    the updated list

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    POST lists/members/destroy | Twitter Developers

  7. abstract def destroyUserListSubscription(listSpecificInfo: SpecificInfo): UserList

    Unsubscribes the authenticated user form the specified list.

    Unsubscribes the authenticated user form the specified list.
    This method calls twitter4j.Twitter.destroyUserListSubscription.
    destroyUserListSubscription calls http://api.twitter.com/1.1/subscribers/destroy.json

    listSpecificInfo

    The list specific information(set list id or set screen name or user id and slug)

    returns

    the updated list

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    POST lists/subscribers/destroy | Twitter Developers

  8. abstract def getUserListMembers(listSpecificInfo: SpecificInfo, cursor: Long): PagableResponseList[twitter4j.User]

    Returns the members of the specified list.

    Returns the members of the specified list.
    This method calls twitter4j.Twitter.getUserListMembers.
    getUserListMembers calls http://api.twitter.com/1.1/lists/members.json

    listSpecificInfo

    The list specific information(set list id or set screen name or user id and slug)

    cursor

    Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.

    returns

    the members of the specified list.

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    GET lists/members | Twitter Developers

  9. abstract def getUserListMemberships(listMemberSpecificUser: SpecificInfo = null, cursor: Long, filterToOwnedLists: Boolean = null): PagableResponseList[twitter4j.UserList]

    List the lists the specified user has been added to.

    List the lists the specified user has been added to.
    This method calls twitter4j.Twitter.getUserListMemberships.
    getUserListMemberships calls http://api.twitter.com/1.1/lists/memberships.json
    Note: Parameter listMemberId is taken priority over listMemberScreenName.

    listMemberSpecificUser

    (optional) the user specific information (screen name or ID) of the list member

    cursor

    (required) Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.

    filterToOwnedLists

    (optional) Whether to return just lists the authenticating user owns, and the user represented by listMemberScreenName is a member of.

    returns

    the list of lists

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    IllegalStateException

    when filerToOwnedLists is true but authorization is not enabled

    TwitterException

    when Twitter service or network is unavailable

    See also

    GET lists/memberships | Twitter Developers

  10. abstract def getUserListStatuses(listSpecificInfo: SpecificInfo, paging: Paging): ResponseList[twitter4j.Status]

    Show tweet timeline for members of the specified list.

    Show tweet timeline for members of the specified list.
    This method calls twitter4j.Twitter.getUserListStatuses.
    getUserListStatuses calls http://api.twitter.com/1.1/lists/statuses.json

    listSpecificInfo

    The list specific information(set list id or set screen name or user id and slug)

    paging

    controls pagination. Supports since_id, max_id, count and page parameters.

    returns

    list of statuses for members of the specified list

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    GET lists/statuses | Twitter Developers

  11. abstract def getUserListSubscribers(listSpecificInfo: SpecificInfo, cursor: Long): PagableResponseList[twitter4j.User]

    Returns the subscribers of the specified list.

    Returns the subscribers of the specified list.
    This method calls twitter4j.Twitter.getUserListSubscribers.
    getUserListSubscribers calls http://api.twitter.com/1.1/lists/subscribers.json

    listSpecificInfo

    The list specific information(set list id or set screen name or user id and slug)

    cursor

    Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.

    returns

    the members of the specified list.

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    twitter4j.TwitterException

    when Twitter service or network is unavailable

    See also

    GET lists/subscribers | Twitter Developers

  12. abstract def getUserListSubscriptions(cursor: Long, listMemberScreenName: String): PagableResponseList[twitter4j.UserList]

    List the lists the specified user follows.

    List the lists the specified user follows.
    This method calls twitter4j.Twitter.getUserListSubscriptions.
    getUserListSubscriptions calls http://api.twitter.com/1.1/lists/subscriptions.json

    cursor

    Breaks the results into pages. A single page contains 20 lists. Provide a value of -1 to begin paging. Provide values as returned to in the response body's next_cursor and previous_cursor attributes to page back and forth in the list.

    listMemberScreenName

    The screen name of the list member

    returns

    the list of lists

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    GET lists/subscriptions | Twitter Developers

  13. abstract def getUserLists(listOwnerSpecificUser: SpecificInfo): ResponseList[twitter4j.UserList]

    List the lists of the specified user.

    List the lists of the specified user. Private lists will be included if the authenticated users is the same as the user whose lists are being returned.
    This method calls twitter4j.Twitter.getUserList.
    getUserList calls http://api.twitter.com/1.1/lists.json
    Note1: You must set listOwnerScreenName or listOwnerUserId at least.
    Note2: Parameter listOwnerUserId is taken priority over listOwnerScreenName.

    listOwnerSpecificUser

    (required) the user specific information(screen name or ID) of the list owner

    returns

    the list of lists

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    IllegalArgumentException

    when listOwnerSpecificUser is set null.

    TwitterException

    when Twitter service or network is unavailable

    See also

    GET lists | Twitter Developers

  14. abstract def showUserList(listSpecificInfo: SpecificInfo): UserList

    Show the specified list.

    Show the specified list. Private lists will only be shown if the authenticated user owns the specified list.
    This method calls twitter4j.Twitter.showUserList.
    showUserList calls http://api.twitter.com/1.1/lists/show.json

    listSpecificInfo

    (required) the user list specific information(list id or [screen name or ID] and list slug)

    returns

    the specified list

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    https://dev.twitter.com/docs/api/1/get/lists/show | Twitter Developers

  15. abstract def showUserListMembership(listSpecificInfo: SpecificInfo, userId: Long): User

    Check if a user is a member of the specified list.

    Check if a user is a member of the specified list.
    This method calls twitter4j.Twitter.showUserListMembership.
    showUserListMembership calls http://api.twitter.com/1.1/lists/members/show.json

    listSpecificInfo

    The list specific information(set list id or set screen name or user id and slug)

    userId

    The id of the user who you want to know is a member or not of the specified list.

    returns

    the updated list

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable , or the user is not a member of the specified list(TwitterException.getStatusCode() returns 404 in that case.)

    See also

    GET lists/members/show | Twitter Developers

  16. abstract def showUserListSubscription(listSpecificInfo: SpecificInfo, userId: Long): User

    Check if the specified user is a subscriber of the specified list.

    Check if the specified user is a subscriber of the specified list.
    This method calls twitter4j.Twitter.showUserListSubscriptions.
    showUserListSubscriptions calls http://api.twitter.com/1.1/lists/subscribers/show.json

    listSpecificInfo

    The list specific information(set list id or set screen name or user id and slug)

    userId

    The id of the user who you want to know is a member or not of the specified list.

    returns

    the updated list

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable , or the user is not a member of the specified list(TwitterException.getStatusCode() returns 404 in that case.)

    See also

    GET lists/subscribers/show | Twitter Developers

  17. abstract def updateUserList(listSpecificInfo: SpecificInfo, newListName: String, isPublicList: Boolean, newDescription: String): UserList

    Updates the specified list.

    Updates the specified list.
    This method calls twitter4j.Twitter.updateUserList.
    updateUserList calls http://api.twitter.com/1.1/lists/update.json

    listSpecificInfo

    (required) the user list specific information(list id or [screen name or ID] and list slug)

    newListName

    What you'd like to change the list's name to.

    isPublicList

    Whether your list is public or private. Optional. Values can be public or private. Lists are public by default if no mode is specified.

    newDescription

    What you'd like to change the list description to.

    returns

    the updated list

    Since

    Twitter4S 1.0.0

    Exceptions thrown
    TwitterException

    when Twitter service or network is unavailable

    See also

    POST lists/update | Twitter Developers

  18. abstract def addUserListMember(listId: Int, userId: Long): UserList

    Deprecated

    use {@list #createUserListMember(UserList.SpecificInfo, Long)} instead

  19. abstract def addUserListMembers(listId: Int, specificUsers: SpecificInfo): UserList

    Deprecated

    use #createUserListMembers(UserList.SpecificInfo, Users.SpecificInfo) instead

  20. abstract def deleteUserListMember(listId: Int, userId: Long): UserList

    Deprecated

    use #destroyUserListMember(UserList.SpecificInfo, Long) instead

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