getListFollowers(__fields_expansions_paginationToken_maxResults_) - daneden/Twift GitHub Wiki

getListFollowers(_:fields:expansions:paginationToken:maxResults:)

Returns a list of users who are followers of the specified List.

public func getListFollowers(_ listId: List.ID,
                               fields: Set<User.Field> = [],
                               expansions: [User.Expansions] = [],
                               paginationToken: String? = nil,
                               maxResults: Int = 100
  )

Parameters

  • listId: The ID of the List whose followers you would like to retrieve.
  • fields: Any additional fields to include on returned objects
  • expansions: Objects and their corresponding fields that should be expanded in the includes property
  • paginationToken: When iterating over pages of results, you can pass in the nextToken from the previously-returned value to get the next page of results
  • maxResults: The maximum number of results to fetch.

Returns

A response object containing an array of Users following the list, any requested expansions, and a meta object with pagination information

⚠️ **GitHub.com Fallback** ⚠️