Class KarteApp

KARTE SDKのエントリポイントクラスです。

Hierarchy

  • KarteApp

Accessors

isOptOut visitorId

Methods

optIn optOut renewVisitorId

Accessors

Static isOptOut

  • get isOptOut(): boolean

  • オプトアウトの設定有無を返します。

    Remarks

    オプトアウトされている場合は、true を返し、されていない場合は false を返します。

    また初期化が行われていない場合は false を返します。

    Returns boolean

Static visitorId

  • get visitorId(): string

  • ビジターIDを返します。

    Remarks

    ユーザーを一意に識別するためのID（ビジターID）を返します。

    なお初期化が行われていない場合は空文字列を返します。

    Returns string

Methods

Static optIn

  • オプトインします。

    Remarks

    初期化が行われていない状態で呼び出した場合はオプトインは行われません。

    Returns void

Static optOut

  • オプトアウトします。

    Remarks

    初期化が行われていない状態で呼び出した場合はオプトアウトは行われません。

    Returns void

Static renewVisitorId

  • ビジターIDを再生成します。

    Remarks

    ビジターIDの再生成は、現在のユーザーとは異なるユーザーとして計測したい場合などに行います。 例えば、アプリケーションでログアウトを行った場合などがこれに該当します。

    なお初期化が行われていない状態で呼び出した場合は再生成は行われません。

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc