Skip to content

getBlockedUsers(for_fields_expansions_paginationToken_maxResults_)

daneden edited this page Apr 3, 2022 · 9 revisions

getBlockedUsers(for:fields:expansions:paginationToken:maxResults:)

Returns a list of users who are blocked by the specified user ID.

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

Equivalent to GET /2/users/:id/blocking.

Parameters

  • userId: The user ID whose blocked users 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 Twitter API response object containing an array of User structs and any pinned tweets in the includes property

Types
Global Variables
Global Functions
Extensions
Clone this wiki locally