class TikToker::ProfileIterator

• TikToker::ProfileIterator
• Reference
• Object

Overview

A ProfileIterator allows iterating a TikTok::UserProfile by page.

For example:

iterator = TikToker::ProfileIterator.new("SecUID", "0")
iterator.next # => Page 1
iterator.next # => Page 2
iterator.next # => Iterator::Stop

Most of the time, what you really want is to iterate through the posts without having to worry about pagination. See #each_post.

iterator = TikToker::ProfileIterator.new("SecUID", "0")
iterator.each_post do |post|
  post # => TikTok::Post
end

Included Modules

• Iterator(TikToker::TikTok::Post)

Defined in:

Constructors

• .new(sec_uid, cursor)

Instance Method Summary

• #cursor : String

  Returns the current cursor position of the iterator.

• #each_post(&)

  Yields successive posts from the user profile.

• #has_more?

  Returns true until the iterator receives a TikTok response indicating that the user profile has been fully iterated over.

• #next

  Fetches the next page from the user profile, and updates the cursor position.

• #sec_uid : SecUID

  Returns the secUid of the owner of the profile being iterated through.

Constructor Detail

Instance Method Detail

iterator = TikToker::ProfileIterator.new(SEC_UID, "0")
iterator.each_post do |post|
  post # => TikTok::Post
end

iterator = TikToker::ProfileIterator.new(SEC_UID, "0")
iterator.has_more? # => true
iterator.next      # => TikTok::PostCollection
iterator.has_more? # => false
iterator.next      # => Iterator::Stop

iterator = TikToker::ProfileIterator.new(SEC_UID, "0")
iterator.cursor # => "0"
iterator.next   # => Array(TikTok::Post)
iterator.cursor # => "1614377227000"