Skip to content

docs: Add setSessionId to reference website #397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 28, 2021
Merged

docs: Add setSessionId to reference website #397

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0934c80
Added example and description for setSessionId method
jarrenpatao May 28, 2021
9d1f364
Merge branch 'amplitude:master' into master
jarrenpatao May 28, 2021
2594323
Pulled off master to update to latest version
jarrenpatao May 28, 2021
b0e7915
Fixing accidental deletion of a letter for setOptOut
jarrenpatao May 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/amplitude-client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -974,6 +974,14 @@ AmplitudeClient.prototype.setOptOut = function setOptOut(enable) {
}
};

/**
* Set a custom Session ID for the current session.
* Note: This is not recommended unless you know what you are doing because the Session ID of a session is utilized for all session metrics in Amplitude.
* The Session ID to set for the current session must be in milliseconds since epoch (Unix Timestamp).
Copy link
Contributor

@kelvin-lu kelvin-lu May 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is me just not knowing the exact spec here. Is this req'd or just a suggestion?

Copy link
Contributor Author

@jarrenpatao jarrenpatao May 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually what was previously documented in our Help Center. If this is not req'd, then we can definitely edit the text.

Copy link
Contributor

@kelvin-lu kelvin-lu May 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't know either. I'll ask the dataPL/Query teams

* @public
* @param {int} sessionId to set.
* @example amplitudeClient.setSessionId(1622158968000);
*/
AmplitudeClient.prototype.setSessionId = function setSessionId(sessionId) {
if (!utils.validateInput(sessionId, 'sessionId', 'number')) {
return;
Expand Down