class

TikToker::Configuration

Inherits Reference / Object

Constants

TIKTOK_HOST = "www.tiktok.com"
TIKTOK_PORTAL = "https://www.tiktok.com"

Instance methods

connect_timeout

Timeout waiting for TikTok server connection to open in seconds.

Source
connect_timeout=(connect_timeout : Int32)

Timeout waiting for TikTok server connection to open in seconds.

Source
did

TikTok device id. Keep in mind that this token is supposed to be long-lived and consistent between requests.

TikToker::Util.generate_did # => 3745502480601580487
Source
did=(did : String)

TikTok device id. Keep in mind that this token is supposed to be long-lived and consistent between requests.

TikToker::Util.generate_did # => 3745502480601580487
Source
fast_update

Stop when encountering the first already-downloaded video. This flag is recommended when you use TikToker to update your personal archive.

Source
fast_update=(fast_update : Bool)

Stop when encountering the first already-downloaded video. This flag is recommended when you use TikToker to update your personal archive.

Source
internal_user_agent

User agent used by TikToker when there is no need to disguise itself, e.g. in requests with an external signature server.

Source
internal_user_agent=(internal_user_agent : String)

User agent used by TikToker when there is no need to disguise itself, e.g. in requests with an external signature server.

Source
proxy_host

Proxy host.

config.proxy_host = "localhost"
Source
proxy_host=(proxy_host : String | Nil)

Proxy host.

config.proxy_host = "localhost"
Source
proxy_pass

Proxy password.

config.proxy_user = "password"
Source
proxy_pass=(proxy_pass : String | Nil)

Proxy password.

config.proxy_user = "password"
Source
proxy_port

Proxy port.

config.proxy_port = 8080
Source
proxy_port=(proxy_port : Int32 | Nil)

Proxy port.

config.proxy_port = 8080
Source
proxy_user

Proxy username.

config.proxy_user = "username"
Source
proxy_user=(proxy_user : String | Nil)

Proxy username.

config.proxy_user = "username"
Source
quiet

Do not produce any output. This makes TikToker suitable as a cron job.

Source
quiet=(bool : Bool)

Changes the log severity to Log::Severity::Error if set to true.

config.quiet = true
Source
read_timeout

Timeout when waiting for TikTok server to return data.

Source
read_timeout=(read_timeout : Int32)

Timeout when waiting for TikTok server to return data.

Source
retry_attempts

Maximum number of retry attempts until a request is aborted. When using TikTok as a library, you might want to set it to zero.

Source
retry_attempts=(retry_attempts : Int32)

Maximum number of retry attempts until a request is aborted. When using TikTok as a library, you might want to set it to zero.

Source
session_id

Used to authenticate with TikTok API. Useful to browse and download private profiles.

Source
session_id=(session_id : String | Nil)

Used to authenticate with TikTok API. Useful to browse and download private profiles.

Source
signature_server_timeout

Seconds to wait before timing out a connection request with an external signature server.

Source
signature_server_timeout=(signature_server_timeout : Int32)

Seconds to wait before timing out a connection request with an external signature server.

Source
signature_server_url

External signature server used to sign TikTok API requests. By default, the signature server is expected to be listening locally port 3000.

Source
signature_server_url=(signature_server_url : String)

External signature server used to sign TikTok API requests. By default, the signature server is expected to be listening locally port 3000.

Source
tiktok_host

TikTok API host.

Source
tiktok_host=(tiktok_host : String)

TikTok API host.

Source
tiktok_portal

TikTok portal URL.

Source
tiktok_portal=(tiktok_portal : String)

TikTok portal URL.

Source
verbose

Print debug information for each operation.

Source
verbose=(verbose : Bool)

Print debug information for each operation.

Source
with

Configuration for TikToker.

config = TikToker::Configuration.new
config.with do |config|
  config.signature_server_url = "https://signature.server"
end
Source
write_timeout

Timeout when waiting for TikTok server to receive data.

Source
write_timeout=(write_timeout : Int32)

Timeout when waiting for TikTok server to receive data.

Source