class TikToker::Configuration
- TikToker::Configuration
- Reference
- Object
Defined in:
tiktoker/configuration.crConstant Summary
-
TIKTOK_HOST =
"www.tiktok.com"
-
TIKTOK_PORTAL =
"https://www.tiktok.com"
Instance Method Summary
-
#connect_timeout : Int32
Timeout waiting for TikTok server connection to open in seconds.
-
#connect_timeout=(connect_timeout : Int32)
Timeout waiting for TikTok server connection to open in seconds.
-
#did : String
TikTok device id.
-
#did=(did : String)
TikTok device id.
-
#fast_update : Bool
Stop when encountering the first already-downloaded video.
-
#fast_update=(fast_update : Bool)
Stop when encountering the first already-downloaded video.
-
#internal_user_agent : String
User agent used by TikToker when there is no need to disguise itself, e.g.
-
#internal_user_agent=(internal_user_agent : String)
User agent used by TikToker when there is no need to disguise itself, e.g.
-
#proxy_host : String | Nil
Proxy host.
-
#proxy_host=(proxy_host : String | Nil)
Proxy host.
-
#proxy_pass : String | Nil
Proxy password.
-
#proxy_pass=(proxy_pass : String | Nil)
Proxy password.
-
#proxy_port : Int32 | Nil
Proxy port.
-
#proxy_port=(proxy_port : Int32 | Nil)
Proxy port.
-
#proxy_user : String | Nil
Proxy username.
-
#proxy_user=(proxy_user : String | Nil)
Proxy username.
-
#quiet : Bool
Do not produce any output.
-
#quiet=(bool : Bool)
Changes the log severity to
Log::Severity::Error
if set to true. -
#read_timeout : Int32
Timeout when waiting for TikTok server to return data.
-
#read_timeout=(read_timeout : Int32)
Timeout when waiting for TikTok server to return data.
-
#retry_attempts : Int32
Maximum number of retry attempts until a request is aborted.
-
#retry_attempts=(retry_attempts : Int32)
Maximum number of retry attempts until a request is aborted.
-
#session_id : String | Nil
Used to authenticate with TikTok API.
-
#session_id=(session_id : String | Nil)
Used to authenticate with TikTok API.
-
#signature_server_timeout : Int32
Seconds to wait before timing out a connection request with an external signature server.
-
#signature_server_timeout=(signature_server_timeout : Int32)
Seconds to wait before timing out a connection request with an external signature server.
-
#signature_server_url : String
External signature server used to sign TikTok API requests.
-
#signature_server_url=(signature_server_url : String)
External signature server used to sign TikTok API requests.
-
#tiktok_host : String
TikTok API host.
-
#tiktok_host=(tiktok_host : String)
TikTok API host.
-
#tiktok_portal : String
TikTok portal URL.
-
#tiktok_portal=(tiktok_portal : String)
TikTok portal URL.
-
#verbose : Bool
Print debug information for each operation.
-
#verbose=(verbose : Bool)
Print debug information for each operation.
-
#with(&) : Nil
Configuration for TikToker.
-
#write_timeout : Int32
Timeout when waiting for TikTok server to receive data.
-
#write_timeout=(write_timeout : Int32)
Timeout when waiting for TikTok server to receive data.
Instance Method Detail
Timeout waiting for TikTok server connection to open in seconds.
TikTok device id. Keep in mind that this token is supposed to be long-lived and consistent between requests.
TikToker::Util.generate_did # => 3745502480601580487
TikTok device id. Keep in mind that this token is supposed to be long-lived and consistent between requests.
TikToker::Util.generate_did # => 3745502480601580487
Stop when encountering the first already-downloaded video. This flag is recommended when you use TikToker to update your personal archive.
Stop when encountering the first already-downloaded video. This flag is recommended when you use TikToker to update your personal archive.
User agent used by TikToker when there is no need to disguise itself, e.g. in requests with an external signature server.
User agent used by TikToker when there is no need to disguise itself, e.g. in requests with an external signature server.
Changes the log severity to Log::Severity::Error
if set to true.
config.quiet = true
Maximum number of retry attempts until a request is aborted. When using TikTok as a library, you might want to set it to zero.
Maximum number of retry attempts until a request is aborted. When using TikTok as a library, you might want to set it to zero.
Used to authenticate with TikTok API. Useful to browse and download private profiles.
Used to authenticate with TikTok API. Useful to browse and download private profiles.
Seconds to wait before timing out a connection request with an external signature server.
Seconds to wait before timing out a connection request with an external signature server.
External signature server used to sign TikTok API requests. By default, the signature server is expected to be listening locally port 3000.
External signature server used to sign TikTok API requests. By default, the signature server is expected to be listening locally port 3000.
Configuration for TikToker.
config = TikToker::Configuration.new
config.with do |config|
config.signature_server_url = "https://signature.server"
end