Skip to content

Commit

Permalink
Applying documentation updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Aug 16, 2021
1 parent 3e1f676 commit 8d5a43b
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ interface BrowserTracker
| [setCookiePath](./browser-tracker.browsertracker.setcookiepath.md) | (path: string) => void | Set first-party cookie path |
| [setCustomUrl](./browser-tracker.browsertracker.setcustomurl.md) | (url: string) => void | Override url |
| [setDocumentTitle](./browser-tracker.browsertracker.setdocumenttitle.md) | (title: string) => void | Override document.title |
| [setOptOutCookie](./browser-tracker.browsertracker.setoptoutcookie.md) | (name: string) => void | Sets the opt out cookie. |
| [setOptOutCookie](./browser-tracker.browsertracker.setoptoutcookie.md) | (name?: string \| null) => void | Sets the opt out cookie. |
| [setReferrerUrl](./browser-tracker.browsertracker.setreferrerurl.md) | (url: string) => void | Override referrer |
| [setUserId](./browser-tracker.browsertracker.setuserid.md) | (userId: string) => void | Set the business-defined user ID for this user. |
| [setUserId](./browser-tracker.browsertracker.setuserid.md) | (userId?: string \| null) => void | Set the business-defined user ID for this user. |
| [setUserIdFromCookie](./browser-tracker.browsertracker.setuseridfromcookie.md) | (cookieName: string) => void | Set the business-defined user ID for this user to the value of a cookie. |
| [setUserIdFromLocation](./browser-tracker.browsertracker.setuseridfromlocation.md) | (querystringField: string) => void | Set the business-defined user ID for this user using the location querystring. |
| [setUserIdFromReferrer](./browser-tracker.browsertracker.setuseridfromreferrer.md) | (querystringField: string) => void | Set the business-defined user ID for this user using the referrer querystring. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Sets the opt out cookie.
<b>Signature:</b>

```typescript
setOptOutCookie: (name: string) => void;
setOptOutCookie: (name?: string | null) => void;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Set the business-defined user ID for this user.
<b>Signature:</b>

```typescript
setUserId: (userId: string) => void;
setUserId: (userId?: string | null) => void;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Sets the opt out cookie.
<b>Signature:</b>

```typescript
declare function setOptOutCookie(name: string, trackers?: Array<string>): void;
declare function setOptOutCookie(name?: string | null, trackers?: Array<string>): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| name | string | of the opt out cookie |
| name | string \| null | of the opt out cookie |
| trackers | Array&lt;string&gt; | The tracker identifiers which will be configured |

<b>Returns:</b>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Set the business-defined user ID for this user.
<b>Signature:</b>

```typescript
declare function setUserId(userId: string, trackers?: Array<string>): void;
declare function setUserId(userId?: string | null, trackers?: Array<string>): void;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| userId | string | The business-defined user ID |
| userId | string \| null | The business-defined user ID |
| trackers | Array&lt;string&gt; | The tracker identifiers which will be configured |

<b>Returns:</b>
Expand Down

0 comments on commit 8d5a43b

Please sign in to comment.