@capawesome/capacitor-posthog
Version:
Unofficial Capacitor plugin for PostHog SDK.
835 lines • 19.2 kB
JSON
{
"api": {
"name": "PosthogPlugin",
"slug": "posthogplugin",
"docs": "",
"tags": [],
"methods": [
{
"name": "alias",
"signature": "(options: AliasOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "AliasOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "6.0.0"
}
],
"docs": "Assign another distinct ID to the current user.",
"complexTypes": [
"AliasOptions"
],
"slug": "alias"
},
{
"name": "capture",
"signature": "(options: CaptureOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "CaptureOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "6.0.0"
}
],
"docs": "Capture an event.",
"complexTypes": [
"CaptureOptions"
],
"slug": "capture"
},
{
"name": "flush",
"signature": "() => Promise<void>",
"parameters": [],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "6.0.0"
}
],
"docs": "Flush all events in the queue.\n\nOnly available on Android and iOS.",
"complexTypes": [],
"slug": "flush"
},
{
"name": "getFeatureFlag",
"signature": "(options: GetFeatureFlagOptions) => Promise<GetFeatureFlagResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "GetFeatureFlagOptions"
}
],
"returns": "Promise<GetFeatureFlagResult>",
"tags": [
{
"name": "since",
"text": "7.0.0"
}
],
"docs": "Get the value of a feature flag.",
"complexTypes": [
"GetFeatureFlagResult",
"GetFeatureFlagOptions"
],
"slug": "getfeatureflag"
},
{
"name": "getFeatureFlagPayload",
"signature": "(options: GetFeatureFlagPayloadOptions) => Promise<GetFeatureFlagPayloadResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "GetFeatureFlagPayloadOptions"
}
],
"returns": "Promise<GetFeatureFlagPayloadResult>",
"tags": [
{
"name": "since",
"text": "7.1.0"
}
],
"docs": "Get the payload of a feature flag.",
"complexTypes": [
"GetFeatureFlagPayloadResult",
"GetFeatureFlagPayloadOptions"
],
"slug": "getfeatureflagpayload"
},
{
"name": "group",
"signature": "(options: GroupOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "GroupOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "6.0.0"
}
],
"docs": "Associate the events for that user with a group.",
"complexTypes": [
"GroupOptions"
],
"slug": "group"
},
{
"name": "identify",
"signature": "(options: IdentifyOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "IdentifyOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "6.0.0"
}
],
"docs": "Identify the current user.",
"complexTypes": [
"IdentifyOptions"
],
"slug": "identify"
},
{
"name": "isFeatureEnabled",
"signature": "(options: IsFeatureEnabledOptions) => Promise<IsFeatureEnabledResult>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "IsFeatureEnabledOptions"
}
],
"returns": "Promise<IsFeatureEnabledResult>",
"tags": [
{
"name": "since",
"text": "7.0.0"
}
],
"docs": "Check if a feature flag is enabled.",
"complexTypes": [
"IsFeatureEnabledResult",
"IsFeatureEnabledOptions"
],
"slug": "isfeatureenabled"
},
{
"name": "register",
"signature": "(options: RegisterOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "RegisterOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "6.0.0"
}
],
"docs": "Register a new super property. This property will be sent with every event.",
"complexTypes": [
"RegisterOptions"
],
"slug": "register"
},
{
"name": "reloadFeatureFlags",
"signature": "() => Promise<void>",
"parameters": [],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "7.0.0"
}
],
"docs": "Reload the feature flags.",
"complexTypes": [],
"slug": "reloadfeatureflags"
},
{
"name": "reset",
"signature": "() => Promise<void>",
"parameters": [],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "6.0.0"
}
],
"docs": "Reset the current user's ID and anonymous ID.",
"complexTypes": [],
"slug": "reset"
},
{
"name": "screen",
"signature": "(options: ScreenOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "ScreenOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "6.0.0"
}
],
"docs": "Send a screen event.\n\nOnly available on Android and iOS.",
"complexTypes": [
"ScreenOptions"
],
"slug": "screen"
},
{
"name": "setup",
"signature": "(options: SetupOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "SetupOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "6.0.0"
}
],
"docs": "Setup the PostHog SDK with the provided options.\n\n**Attention**: This method should be called before any other method.",
"complexTypes": [
"SetupOptions"
],
"slug": "setup"
},
{
"name": "unregister",
"signature": "(options: UnregisterOptions) => Promise<void>",
"parameters": [
{
"name": "options",
"docs": "",
"type": "UnregisterOptions"
}
],
"returns": "Promise<void>",
"tags": [
{
"name": "since",
"text": "6.0.0"
}
],
"docs": "Remove a super property.",
"complexTypes": [
"UnregisterOptions"
],
"slug": "unregister"
}
],
"properties": []
},
"interfaces": [
{
"name": "AliasOptions",
"slug": "aliasoptions",
"docs": "",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "alias",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"docs": "The new distinct ID to assign to the current user.",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "CaptureOptions",
"slug": "captureoptions",
"docs": "",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "event",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"docs": "The name of the event to capture.",
"complexTypes": [],
"type": "string"
},
{
"name": "properties",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"docs": "The properties to send with the event.",
"complexTypes": [
"Record"
],
"type": "Record<string, any>"
}
]
},
{
"name": "GetFeatureFlagResult",
"slug": "getfeatureflagresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "value",
"tags": [
{
"text": "7.0.0",
"name": "since"
}
],
"docs": "The value of the feature flag.\n\nIf the feature flag does not exist, the value will be `null`.",
"complexTypes": [],
"type": "string | boolean | null"
}
]
},
{
"name": "GetFeatureFlagOptions",
"slug": "getfeatureflagoptions",
"docs": "",
"tags": [
{
"text": "7.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "key",
"tags": [
{
"text": "7.0.0",
"name": "since"
}
],
"docs": "The key of the feature flag.",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "GetFeatureFlagPayloadResult",
"slug": "getfeatureflagpayloadresult",
"docs": "",
"tags": [],
"methods": [],
"properties": [
{
"name": "value",
"tags": [
{
"text": "7.1.0",
"name": "since"
}
],
"docs": "The value of the feature flag payload.",
"complexTypes": [
"JsonType"
],
"type": "JsonType"
}
]
},
{
"name": "GetFeatureFlagPayloadOptions",
"slug": "getfeatureflagpayloadoptions",
"docs": "",
"tags": [
{
"text": "7.1.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "key",
"tags": [
{
"text": "7.1.0",
"name": "since"
}
],
"docs": "The key of the feature flag.",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "GroupOptions",
"slug": "groupoptions",
"docs": "",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "type",
"tags": [
{
"text": "6.0.0",
"name": "since"
},
{
"text": "'company'",
"name": "example"
}
],
"docs": "The group type.",
"complexTypes": [],
"type": "string"
},
{
"name": "key",
"tags": [
{
"text": "6.0.0",
"name": "since"
},
{
"text": "'company_id_in_your_db'",
"name": "example"
}
],
"docs": "The group key.",
"complexTypes": [],
"type": "string"
},
{
"name": "groupProperties",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"docs": "The properties to send with the group event.",
"complexTypes": [
"Record"
],
"type": "Record<string, any>"
}
]
},
{
"name": "IdentifyOptions",
"slug": "identifyoptions",
"docs": "",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "distinctId",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"docs": "The distinct ID of the user.",
"complexTypes": [],
"type": "string"
},
{
"name": "userProperties",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"docs": "The person properties to set.",
"complexTypes": [
"Record"
],
"type": "Record<string, any>"
}
]
},
{
"name": "IsFeatureEnabledResult",
"slug": "isfeatureenabledresult",
"docs": "",
"tags": [
{
"text": "7.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "enabled",
"tags": [
{
"text": "7.0.0",
"name": "since"
}
],
"docs": "Whether the feature flag is enabled.\n\nIf the feature flag does not exist, the value will be `false`.",
"complexTypes": [],
"type": "boolean"
}
]
},
{
"name": "IsFeatureEnabledOptions",
"slug": "isfeatureenabledoptions",
"docs": "",
"tags": [
{
"text": "7.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "key",
"tags": [
{
"text": "7.0.0",
"name": "since"
}
],
"docs": "The key of the feature flag.",
"complexTypes": [],
"type": "string"
}
]
},
{
"name": "RegisterOptions",
"slug": "registeroptions",
"docs": "",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "key",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"docs": "The name of the super property.",
"complexTypes": [],
"type": "string"
},
{
"name": "value",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"docs": "The value of the super property.",
"complexTypes": [],
"type": "any"
}
]
},
{
"name": "ScreenOptions",
"slug": "screenoptions",
"docs": "",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "screenTitle",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"docs": "The name of the screen.",
"complexTypes": [],
"type": "string"
},
{
"name": "properties",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"docs": "The properties to send with the screen event.",
"complexTypes": [
"Record"
],
"type": "Record<string, any>"
}
]
},
{
"name": "SetupOptions",
"slug": "setupoptions",
"docs": "",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "apiKey",
"tags": [
{
"text": "6.0.0",
"name": "since"
},
{
"text": "'phc_g8wMenebiIQ1pYd5v9Vy7oakn6MczVKIsNG5ZHCspdy'",
"name": "example"
}
],
"docs": "The API key of your PostHog project.",
"complexTypes": [],
"type": "string"
},
{
"name": "host",
"tags": [
{
"text": "6.0.0",
"name": "since"
},
{
"text": "'https://eu.i.posthog.com'",
"name": "example"
},
{
"text": "'https://us.i.posthog.com'",
"name": "default"
}
],
"docs": "The host of your PostHog instance.",
"complexTypes": [],
"type": "string | undefined"
}
]
},
{
"name": "UnregisterOptions",
"slug": "unregisteroptions",
"docs": "",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"methods": [],
"properties": [
{
"name": "key",
"tags": [
{
"text": "6.0.0",
"name": "since"
}
],
"docs": "The name of the super property to remove.",
"complexTypes": [],
"type": "string"
}
]
}
],
"enums": [],
"typeAliases": [
{
"name": "Record",
"slug": "record",
"docs": "Construct a type with a set of properties K of type T",
"types": [
{
"text": "{\r\n [P in K]: T;\r\n}",
"complexTypes": [
"K",
"T"
]
}
]
},
{
"name": "JsonType",
"slug": "jsontype",
"docs": "",
"types": [
{
"text": "string",
"complexTypes": []
},
{
"text": "number",
"complexTypes": []
},
{
"text": "boolean",
"complexTypes": []
},
{
"text": "null",
"complexTypes": []
},
{
"text": "{\n [key: string]: JsonType;\n }",
"complexTypes": [
"JsonType"
]
},
{
"text": "JsonType[]",
"complexTypes": [
"JsonType"
]
}
]
}
],
"pluginConfigs": []
}