TikTok for Developers

Developer Docs

Last updated October 5, 2026

System Information

These properties and methods provide access to the runtime environment, SDK version, game version, launch parameters, and device system information.

TT.InContainerEnv

A Boolean property indicating whether the game is running inside the TikTok container environment.

Returns

Type

Description

bool

true if running inside the TikTok container; false otherwise

TT.s_ContainerEnv

Static Boolean field indicating whether the game is running inside the TikTok container environment. Equivalent to InContainerEnv but accessible as a static field.

Returns

Type

Description

bool

true if running inside the TikTok container

TT.TTSDKVersion

Returns the version string of the TikTok SDK currently in use.

Returns

Type

Description

string

SDK version string

TT.GameVersion

Returns the version string of the mini game.

Returns

Type

Description

string

Game version string

TT.GamePublishVersion

Returns the published version string of the mini game.

Returns

Type

Description

string

Published game version string

TT.GetContainerVersion()

Returns the version string of the TikTok container application.

Returns

Type

Description

string

Container version string

TT.GetLaunchOptionsSync()

Synchronously retrieves the launch options passed to the mini game when it was started.

Returns

Field

Type

Description

scene

int

Launch scene

query

Dictionary<string, string>

Query parameters

referrerInfo

object

Referrer information

TT.GetSystemInfo()

Retrieves device and system information including platform, language, screen dimensions, and SDK version.

Returns

Field

Type

Description

platform

string

Client platform (ios, android)

system

string

Operating system and version

language

string

Device language

version

string

Client version

SDKVersion

string

SDK version

screenWidth

int

Screen width in px

screenHeight

int

Screen height in px

windowWidth

int

Available window width in px

windowHeight

int

Available window height in px

devicePixelRatio

double

Device pixel ratio

statusBarHeight

int

Status bar height

TT.CanIUse

A static utility class that exposes Boolean properties for checking whether specific API capabilities are available in the current runtime. Check the relevant property before calling the corresponding API.

Properties

Property

Type

Description

Login

bool

Whether TT.Login is available

Authorize

bool

Whether TT.Authorize is available

RequestSubscribeMessage

bool

Whether TT.RequestSubscribeMessage is available

Pay

bool

Whether TT.Pay is available

NavigateToBalance

bool

Whether TT.NavigateToBalance is available

CheckBalance

bool

Whether TT.CheckBalance is available

Recharge

bool

Whether TT.Recharge is available

StartEntranceMission

bool

Whether TT.StartEntranceMission is available

GetEntranceMissionReward

bool

Whether TT.GetEntranceMissionReward is available

AddShortcut

bool

Whether TT.AddShortcut is available

GetShortcutMissionReward

bool

Whether TT.GetShortcutMissionReward is available

GetAppLifeCycle

bool

Whether TT.GetAppLifeCycle is available

SetOnBeforeExitAppListener

bool

Whether TT.SetOnBeforeExitAppListener is available

Request

bool

Whether TT.Request is available

GetNetWorkType

bool

Whether TT.GetNetWorkType is available

OnNetworkStatusChange

bool

Whether TT.OnNetworkStatusChange is available

OffNetworkStatusChange

bool

Whether TT.OffNetworkStatusChange is available

OnNetworkWeakChange

bool

Whether TT.OnNetworkWeakChange is available

OffNetworkWeakChange

bool

Whether TT.OffNetworkWeakChange is available

CreateRewardedVideoAd

bool

Whether TT.CreateRewardedVideoAd is available

CreateInterstitialAd

bool

Whether TT.CreateInterstitialAd is available

ShareAppMessage

bool

Whether TT.ShareAppMessage is available

ShowKeyboard

bool

Whether TT.ShowKeyboard is available

HideKeyboard

bool

Whether TT.HideKeyboard is available

SetPreferredFramesPerSecond

bool

Whether TT.SetPreferredFramesPerSecond is available

VibrateShort

bool

Whether TT.VibrateShort is available

VibrateLong

bool

Whether TT.VibrateLong is available

ReportEvent

bool

Whether TT.ReportEvent is available

ReportScene

bool

Whether TT.ReportScene is available

GetFeedManager

bool

Whether TT.GetFeedManager is available

GetFileSystemManager

bool

Whether TT.GetFileSystemManager is available

TikTok for Developers