getUserOwnedLists(__fields_expansions_paginationToken_maxResults_) - daneden/Twift GitHub Wiki

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

Returns all Lists owned by the specified user.

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

Equivalent to GET /2/user/:user_id/owned_lists

Parameters

  • userId: The user ID whose owned Lists 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 Lists owned by the user id, any requested expansions, and a meta object with pagination tokens

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