@aws-amplify/analytics
Version:
Analytics category of aws-amplify
79 lines (76 loc) • 2.74 kB
JavaScript
import { AnalyticsAction } from '@aws-amplify/core/internals/utils';
import { updateEndpoint } from '@aws-amplify/core/internals/providers/pinpoint';
import '@aws-amplify/core';
import '../../../errors/validation.mjs';
import '../../../utils/eventBuffer/EventBuffer.mjs';
import { getAnalyticsUserAgentString } from '../../../utils/userAgent.mjs';
import '../../../trackers/EventTracker.mjs';
import '../../../trackers/PageViewTracker.mjs';
import '../../../trackers/SessionTracker.mjs';
import { resolveConfig } from '../utils/resolveConfig.mjs';
import { resolveCredentials } from '../utils/resolveCredentials.mjs';
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
/**
* Sends information about a user to Pinpoint. Sending user information allows you to associate a user to their user
* profile and activities or actions in your application. Activity can be tracked across devices & platforms by using
* the same `userId`.
*
* @param {IdentifyUserInput} params The input object used to construct requests sent to Pinpoint's UpdateEndpoint
* API.
*
* @throws service: {@link UpdateEndpointException} - Thrown when the underlying Pinpoint service returns an error.
* @throws validation: {@link AnalyticsValidationErrorCode} - Thrown when the provided parameters or library
* configuration is incorrect.
*
* @returns A promise that will resolve when the operation is complete.
*
* @example
* ```ts
* // Identify a user with Pinpoint
* await identifyUser({
* userId,
* userProfile: {
* email: 'userEmail@example.com'
* customProperties: {
* phoneNumber: ['555-555-5555'],
* },
* }
* });
* ```
*
* @example
* ```ts
* // Identify a user with Pinpoint with some additional demographics
* await identifyUser({
* userId,
* userProfile: {
* email: 'userEmail@example.com'
* customProperties: {
* phoneNumber: ['555-555-5555'],
* },
* demographic: {
* platform: 'ios',
* timezone: 'America/Los_Angeles'
* }
* }
* });
*/
const identifyUser = async ({ userId, userProfile, options, }) => {
const { credentials, identityId } = await resolveCredentials();
const { appId, region } = resolveConfig();
const { userAttributes } = options ?? {};
await updateEndpoint({
appId,
category: 'Analytics',
credentials,
identityId,
region,
userAttributes,
userId,
userProfile,
userAgentValue: getAnalyticsUserAgentString(AnalyticsAction.IdentifyUser),
});
};
export { identifyUser };
//# sourceMappingURL=identifyUser.mjs.map