Index (Analytics Client API Plugin 9.2.1 API)

A B C D E G H I K L M P S V W
All Classes and Interfaces|All Packages|Constant Field Values

A

Analytics - Annotation Interface in com.atlassian.analytics.api.annotations: Deprecated.
as of 2.25. Use EventName instead.
ANALYTICS_DISABLED_DATE - Enum constant in enum class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent.Key
ANALYTICS_DISABLED_USERNAME - Enum constant in enum class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent.Key
ANALYTICS_ENABLED - Enum constant in enum class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent.Key: Deprecated.
ANALYTICS_OPTION - Enum constant in enum class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent.Key
AnalyticsConfigChangedEvent - Class in com.atlassian.analytics.api.events: Published when analytics configuration is updated.
AnalyticsConfigChangedEvent(AnalyticsConfigChangedEvent.Key, String, String) - Constructor for class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent
AnalyticsConfigChangedEvent.Key - Enum Class in com.atlassian.analytics.api.events
AnalyticsConfigService - Interface in com.atlassian.analytics.api.services: Services related to the Atlassian Analytics configuration.
AnalyticsConfigStateEvent - Class in com.atlassian.analytics.api.events
AnalyticsConfigStateEvent(boolean, String, boolean, boolean, boolean) - Constructor for class com.atlassian.analytics.api.events.AnalyticsConfigStateEvent
AnalyticsConnectivityCheckEvent - Class in com.atlassian.analytics.api.events
AnalyticsConnectivityCheckEvent() - Constructor for class com.atlassian.analytics.api.events.AnalyticsConnectivityCheckEvent
AnalyticsEvent - Interface in com.atlassian.analytics.api.events.v2: Deprecated.
The new API turned out to be impossible/impractical to use and is therefore deprecated. It will be removed in the future. Please use the old API instead: EventName Page listing problems with the new API: https://hello.atlassian.net/wiki/spaces/AB/pages/1097805011/Obstacles+to+wide+adoption+of+the+new+Analytics+API+by+the+products
AnalyticsPluginReadyEvent - Class in com.atlassian.analytics.api.events: This event is sent when the initialisation of the plugin is complete, and the plugin is ready to receive analytics events.
AnalyticsPluginReadyEvent() - Constructor for class com.atlassian.analytics.api.events.AnalyticsPluginReadyEvent
AnalyticsUploadService - Interface in com.atlassian.analytics.api.services: Services related to Atlassian Analytics log uploading.
application(String) - Method in class com.atlassian.analytics.api.events.MauEvent.Builder

B

build(String) - Method in class com.atlassian.analytics.api.events.MauEvent.Builder
Builder() - Constructor for class com.atlassian.analytics.api.events.MauEvent.Builder

C

canCollectAnalytics() - Method in interface com.atlassian.analytics.api.services.AnalyticsConfigService: Returns whether or not we should be collecting analytics, based on if analytics is enabled and the privacy policy banner acknowledged.
com.atlassian.analytics.api.annotations - package com.atlassian.analytics.api.annotations
com.atlassian.analytics.api.annotations.v2 - package com.atlassian.analytics.api.annotations.v2
com.atlassian.analytics.api.events - package com.atlassian.analytics.api.events
com.atlassian.analytics.api.events.v2 - package com.atlassian.analytics.api.events.v2
com.atlassian.analytics.api.extractor - package com.atlassian.analytics.api.extractor
com.atlassian.analytics.api.listener - package com.atlassian.analytics.api.listener
com.atlassian.analytics.api.services - package com.atlassian.analytics.api.services
Critical - Annotation Interface in com.atlassian.analytics.api.annotations: Indicates that event is critical and should be processed immediately.

D

DESTINATION - Enum constant in enum class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent.Key

E

enrichProperties(Object) - Method in interface com.atlassian.analytics.api.extractor.ProductProvidedPropertyExtractor: Enrich properties
equals(Object) - Method in class com.atlassian.analytics.api.events.MauEvent
EVENT_NAME - Static variable in class com.atlassian.analytics.api.events.MauEvent
EventName - Annotation Interface in com.atlassian.analytics.api.annotations: Provides the event name for an analytics event.
extractName(Object) - Method in interface com.atlassian.analytics.api.extractor.ProductProvidedPropertyExtractor: Extract the name of this event from the event object
extractProperty(String, Object) - Method in interface com.atlassian.analytics.api.extractor.ProductProvidedPropertyExtractor: Extract properties
extractUser(Object, Map<String, Object>) - Method in interface com.atlassian.analytics.api.extractor.ProductProvidedPropertyExtractor: Extract the user from the event

G

getAnalyticsEnabled() - Method in class com.atlassian.analytics.api.events.AnalyticsConfigStateEvent: Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1.0. Use AnalyticsConfigStateEvent.getAnalyticsOption() instead.
getAnalyticsOption() - Method in class com.atlassian.analytics.api.events.AnalyticsConfigStateEvent
getApplication() - Method in class com.atlassian.analytics.api.events.MauEvent
getApplicationAccess() - Method in interface com.atlassian.analytics.api.extractor.ProductProvidedPropertyExtractor: Get the application access for the logged in user associated with this event.
getEmail() - Method in class com.atlassian.analytics.api.events.MauEvent
getEventName() - Method in interface com.atlassian.analytics.api.events.v2.AnalyticsEvent: Deprecated.

When returns empty, then com.atlassian.analytics.client.pipeline.serialize.properties.extractors.v2.NewMetaExtractor#getEventName(Object) will genenerate snake-cased version of class simple name without trailing event.
getFeatureFlagAutoWhitelistGrowEventsEnabled() - Method in class com.atlassian.analytics.api.events.AnalyticsConfigStateEvent: Deprecated, for removal: This API element is subject to removal in a future version.
in 9.1.0
getFeatureFlagEssentialAnalyticsEnabled() - Method in class com.atlassian.analytics.api.events.AnalyticsConfigStateEvent
getFeatureFlagTestDataConnectionEnabled() - Method in class com.atlassian.analytics.api.events.AnalyticsConfigStateEvent
getKey() - Method in class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent
getKey() - Method in enum class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent.Key
getLastUploadDate() - Method in interface com.atlassian.analytics.api.services.AnalyticsUploadService: Returns the last successful analytics upload date.
getNewValue() - Method in class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent
getOldValue() - Method in class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent

H

hashCode() - Method in class com.atlassian.analytics.api.events.MauEvent
Hashed - Annotation Interface in com.atlassian.analytics.api.annotations.v2: This annotation will hash the property returned by getter.
hasUploadedAnalyticsSince(int) - Method in interface com.atlassian.analytics.api.services.AnalyticsUploadService

I

isAdvancedAnalyticsEnabled() - Method in interface com.atlassian.analytics.api.services.AnalyticsConfigService: Returns whether Advanced analytics is selected in the configuration.
isAnalyticsDisabled() - Method in interface com.atlassian.analytics.api.services.AnalyticsConfigService: Returns whether Disabled Analytics is selected in the configuration.
isAnalyticsEnabled() - Method in interface com.atlassian.analytics.api.services.AnalyticsConfigService: Deprecated.
isBasicAnalyticsEnabled() - Method in interface com.atlassian.analytics.api.services.AnalyticsConfigService: Returns whether Basic analytics is selected in the configuration.

K

KEY_PREFIX - Static variable in enum class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent.Key

L

LOGGED_BASE_DATA - Enum constant in enum class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent.Key

M

MauEvent - Class in com.atlassian.analytics.api.events: Represents an eyeball event used for tracking monthly active users in Atlassian applications.
MauEvent.Builder - Class in com.atlassian.analytics.api.events

P

POLICY_ACKNOWLEDGED - Enum constant in enum class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent.Key
PrivacyPolicySafe - Annotation Interface in com.atlassian.analytics.api.annotations: Deprecated.
as of 3.39. Use plugin-level whitelists instead.
processEvent(Object) - Method in interface com.atlassian.analytics.api.listener.ProductAnalyticsEventListener
ProductAnalyticsEventListener - Interface in com.atlassian.analytics.api.listener: Event listener service which allows a product to process analytics events.
ProductProvidedPropertyExtractor - Interface in com.atlassian.analytics.api.extractor: Extractor which allows a product to define how properties are provided to this analytics module

S

SecurityPermitted - Annotation Interface in com.atlassian.analytics.api.annotations.v2: This annotation will pass strings from getters that are marked by it.

V

value() - Element in annotation interface com.atlassian.analytics.api.annotations.Analytics: Deprecated.

Provides the event name for an analytics event.
value() - Element in annotation interface com.atlassian.analytics.api.annotations.EventName: Provides the event name for an analytics event.
value() - Element in annotation interface com.atlassian.analytics.api.annotations.PrivacyPolicySafe: Deprecated.

Describes whether the event/field should be collected for analytics
valueOf(String) - Static method in enum class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent.Key: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.atlassian.analytics.api.events.AnalyticsConfigChangedEvent.Key: Returns an array containing the constants of this enum class, in the order they are declared.

W

withEmail(String) - Static method in class com.atlassian.analytics.api.events.MauEvent

A B C D E G H I K L M P S V W
All Classes and Interfaces|All Packages|Constant Field Values