Skip to content

added cdnAuth configParams, other changes based on feedback #36

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

added cdnAuth configParams, other changes based on feedback #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion source/includes/_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,12 @@ var additionalIDs = {
var configParams = {
disableBeforeUnloadHandler: true, // disables callstats.js's window.onbeforeunload parameter.
applicationVersion: "app_version", // Application version specified by the developer.
disablePrecalltest: true // disables the pre-call test, it is enabled by default.
disablePrecalltest: true // disables the pre-call test.
siteID: "siteID", // The name/ID of the site/campus from where the call/pre-call test is made.
additionalIDs: additionalIDs, // additionalIDs object, contains application related IDs.
collectLegacyStats: true //enables the collection of legacy stats in chrome browser
collectIP: true //enables the collection localIP address
cdnAuth: true //Uses the CDN based URL for contacting Authentication Servers.
Copy link

@eljasala eljasala Feb 12, 2021

Choose a reason for hiding this comment

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

Probably just "Use CDN for authentication"

Copy link

@vr000m vr000m Feb 12, 2021

Choose a reason for hiding this comment

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

Uses the CDN for authentication instead of the authentication within the region associated with your organisation.

};
```

Expand Down Expand Up @@ -72,6 +73,7 @@ It provides developers a method to enable or disable certain features or functio
`collectLegacyStats` | No | by default the value is `true`.
`additionalIDs` | No | JSON object.
`collectIP` | No | by default the value is `true`.
`cdnAuth` | No | by default the value is `true`.

<aside class="error">
Setting `disableBeforeUnloadHandler` to `true` disengages callstats.js's `window.onbeforeunload` handler, and you will need to send the fabricTerminated event for each active PeerConnection. See more details on `fabricTerminated` [event](#step-5-optional-sendfabricevent)
Expand Down
6 changes: 3 additions & 3 deletions source/includes/_auth3p.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ Token supports following claims:
};
}

function csInitCallback (err, msg) {
console.log("Initializing Status: err="+err+" msg="+msg);
}
function csInitCallback(status, msg) {
console.log("Status: " + status + " Msg= " + msg ); }
}

//userID is generated or given by the origin server
callstats.initialize(AppID, exampleTokenGenerator(initialToken), userID, csInitCallback, csStatsCallback, configParams);
Expand Down
4 changes: 2 additions & 2 deletions source/includes/_callbacks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ The WebRTC application can provide callback functions to callstats.js which are
var callstats = new callstats();
callstats.initialize(AppID, AppSecret, localUserId, csInitCallback, csStatsCallback);

function csInitCallback(csError, csErrMsg) {
console.log("Status: errCode= " + csError + " errMsg= " + csErrMsg ); }
function csInitCallback(status, msg) {
console.log("Status: " + status + " Msg= " + msg ); }
}
```

Expand Down