Skip to content

Commit e56256f

Browse files
Applying documentation updates.
1 parent 1a3950a commit e56256f

6 files changed

+42
-8
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/browser-tracker](./browser-tracker.md) &gt; [EmitterConfigurationBase](./browser-tracker.emitterconfigurationbase.md) &gt; [cookieExtensionService](./browser-tracker.emitterconfigurationbase.cookieextensionservice.md)
4+
5+
## EmitterConfigurationBase.cookieExtensionService property
6+
7+
Cookie extension service full URL. This URL will be added to the queue and will be called using a GET method. This option is there to allow the service URL to be called in order to set any required identifiers e.g. extra cookies.
8+
9+
The request respects the `anonymousTracking` option, including the SP-Anonymous header if needed, and any additional custom headers from the customHeaders option.
10+
11+
<b>Signature:</b>
12+
13+
```typescript
14+
cookieExtensionService?: string;
15+
```

api-docs/docs/browser-tracker/markdown/browser-tracker.emitterconfigurationbase.idservice.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44

55
## EmitterConfigurationBase.idService property
66

7-
Id service full URL. This URL will be added to the queue and will be called using a GET method. This option is there to allow the service URL to be called in order to set any required identifiers e.g. extra cookies.
8-
9-
The request respects the `anonymousTracking` option, including the SP-Anonymous header if needed, and any additional custom headers from the customHeaders option.
7+
> Warning: This API is now obsolete.
8+
>
9+
> Use `cookieExtensionService` instead.
10+
>
1011
1112
<b>Signature:</b>
1213

api-docs/docs/browser-tracker/markdown/browser-tracker.emitterconfigurationbase.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ interface EmitterConfigurationBase
1616
| --- | --- | --- |
1717
| [bufferSize?](./browser-tracker.emitterconfigurationbase.buffersize.md) | number | <i>(Optional)</i> The amount of events that should be buffered before sending Recommended to leave as 1 to reduce change of losing events |
1818
| [connectionTimeout?](./browser-tracker.emitterconfigurationbase.connectiontimeout.md) | number | <i>(Optional)</i> How long to wait before aborting requests to the collector |
19+
| [cookieExtensionService?](./browser-tracker.emitterconfigurationbase.cookieextensionservice.md) | string | <i>(Optional)</i> Cookie extension service full URL. This URL will be added to the queue and will be called using a GET method. This option is there to allow the service URL to be called in order to set any required identifiers e.g. extra cookies.<!-- -->The request respects the <code>anonymousTracking</code> option, including the SP-Anonymous header if needed, and any additional custom headers from the customHeaders option. |
1920
| [credentials?](./browser-tracker.emitterconfigurationbase.credentials.md) | "omit" \| "same-origin" \| "include" | <i>(Optional)</i> Controls whether or not the browser sends credentials (defaults to 'include') |
2021
| [customFetch?](./browser-tracker.emitterconfigurationbase.customfetch.md) | (input: Request, options?: RequestInit) =&gt; Promise&lt;Response&gt; | <i>(Optional)</i> Enables overriding the default fetch function with a custom implementation. |
2122
| [customHeaders?](./browser-tracker.emitterconfigurationbase.customheaders.md) | Record&lt;string, string&gt; | <i>(Optional)</i> An object of key value pairs which represent headers to attach when sending a POST request, only works for POST |
2223
| [dontRetryStatusCodes?](./browser-tracker.emitterconfigurationbase.dontretrystatuscodes.md) | number\[\] | <i>(Optional)</i> List of HTTP response status codes for which events sent to Collector should not be retried in future request. Only non-success status codes are considered (greater or equal to 300). The don't retry codes are only considered for GET and POST requests. By default, the tracker retries on all non-success status codes except for 400, 401, 403, 410, and 422 (these don't retry codes will remain even if you set your own <code>dontRetryStatusCodes</code> but can be changed using the <code>retryStatusCodes</code>). |
2324
| [eventMethod?](./browser-tracker.emitterconfigurationbase.eventmethod.md) | EventMethod | <i>(Optional)</i> The preferred technique to use to send events |
2425
| [eventStore?](./browser-tracker.emitterconfigurationbase.eventstore.md) | EventStore | <i>(Optional)</i> Enables providing a custom EventStore implementation to store events before sending them to the collector. |
25-
| [idService?](./browser-tracker.emitterconfigurationbase.idservice.md) | string | <i>(Optional)</i> Id service full URL. This URL will be added to the queue and will be called using a GET method. This option is there to allow the service URL to be called in order to set any required identifiers e.g. extra cookies.<!-- -->The request respects the <code>anonymousTracking</code> option, including the SP-Anonymous header if needed, and any additional custom headers from the customHeaders option. |
26+
| [idService?](./browser-tracker.emitterconfigurationbase.idservice.md) | string | <i>(Optional)</i> |
2627
| [keepalive?](./browser-tracker.emitterconfigurationbase.keepalive.md) | boolean | <i>(Optional)</i> Indicates that the request should be allowed to outlive the webpage that initiated it. Enables collector requests to complete even if the page is closed or navigated away from. Note: Browsers put a limit on keepalive requests of 64KB. In case of multiple keepalive requests in parallel (may happen in case of multiple trackers), the limit is shared. |
2728
| [maxGetBytes?](./browser-tracker.emitterconfigurationbase.maxgetbytes.md) | number | <i>(Optional)</i> The max size a GET request (its complete URL) can be. Requests over this size will be tried as a POST request. |
2829
| [maxPostBytes?](./browser-tracker.emitterconfigurationbase.maxpostbytes.md) | number | <i>(Optional)</i> The max size a POST request can be before the tracker will force send it Also dictates the max size of a POST request before a batch of events is split into multiple requests |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@snowplow/react-native-tracker](./react-native-tracker.md) &gt; [EmitterConfigurationBase](./react-native-tracker.emitterconfigurationbase.md) &gt; [cookieExtensionService](./react-native-tracker.emitterconfigurationbase.cookieextensionservice.md)
4+
5+
## EmitterConfigurationBase.cookieExtensionService property
6+
7+
Cookie extension service full URL. This URL will be added to the queue and will be called using a GET method. This option is there to allow the service URL to be called in order to set any required identifiers e.g. extra cookies.
8+
9+
The request respects the `anonymousTracking` option, including the SP-Anonymous header if needed, and any additional custom headers from the customHeaders option.
10+
11+
<b>Signature:</b>
12+
13+
```typescript
14+
cookieExtensionService?: string;
15+
```

api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.idservice.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44

55
## EmitterConfigurationBase.idService property
66

7-
Id service full URL. This URL will be added to the queue and will be called using a GET method. This option is there to allow the service URL to be called in order to set any required identifiers e.g. extra cookies.
8-
9-
The request respects the `anonymousTracking` option, including the SP-Anonymous header if needed, and any additional custom headers from the customHeaders option.
7+
> Warning: This API is now obsolete.
8+
>
9+
> Use `cookieExtensionService` instead.
10+
>
1011
1112
<b>Signature:</b>
1213

api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfigurationbase.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ interface EmitterConfigurationBase
1616
| --- | --- | --- |
1717
| [bufferSize?](./react-native-tracker.emitterconfigurationbase.buffersize.md) | number | <i>(Optional)</i> The amount of events that should be buffered before sending Recommended to leave as 1 to reduce change of losing events |
1818
| [connectionTimeout?](./react-native-tracker.emitterconfigurationbase.connectiontimeout.md) | number | <i>(Optional)</i> How long to wait before aborting requests to the collector |
19+
| [cookieExtensionService?](./react-native-tracker.emitterconfigurationbase.cookieextensionservice.md) | string | <i>(Optional)</i> Cookie extension service full URL. This URL will be added to the queue and will be called using a GET method. This option is there to allow the service URL to be called in order to set any required identifiers e.g. extra cookies.<!-- -->The request respects the <code>anonymousTracking</code> option, including the SP-Anonymous header if needed, and any additional custom headers from the customHeaders option. |
1920
| [credentials?](./react-native-tracker.emitterconfigurationbase.credentials.md) | "omit" \| "same-origin" \| "include" | <i>(Optional)</i> Controls whether or not the browser sends credentials (defaults to 'include') |
2021
| [customFetch?](./react-native-tracker.emitterconfigurationbase.customfetch.md) | (input: Request, options?: RequestInit) =&gt; Promise&lt;Response&gt; | <i>(Optional)</i> Enables overriding the default fetch function with a custom implementation. |
2122
| [customHeaders?](./react-native-tracker.emitterconfigurationbase.customheaders.md) | Record&lt;string, string&gt; | <i>(Optional)</i> An object of key value pairs which represent headers to attach when sending a POST request, only works for POST |
2223
| [dontRetryStatusCodes?](./react-native-tracker.emitterconfigurationbase.dontretrystatuscodes.md) | number\[\] | <i>(Optional)</i> List of HTTP response status codes for which events sent to Collector should not be retried in future request. Only non-success status codes are considered (greater or equal to 300). The don't retry codes are only considered for GET and POST requests. By default, the tracker retries on all non-success status codes except for 400, 401, 403, 410, and 422 (these don't retry codes will remain even if you set your own <code>dontRetryStatusCodes</code> but can be changed using the <code>retryStatusCodes</code>). |
2324
| [eventMethod?](./react-native-tracker.emitterconfigurationbase.eventmethod.md) | EventMethod | <i>(Optional)</i> The preferred technique to use to send events |
2425
| [eventStore?](./react-native-tracker.emitterconfigurationbase.eventstore.md) | EventStore | <i>(Optional)</i> Enables providing a custom EventStore implementation to store events before sending them to the collector. |
25-
| [idService?](./react-native-tracker.emitterconfigurationbase.idservice.md) | string | <i>(Optional)</i> Id service full URL. This URL will be added to the queue and will be called using a GET method. This option is there to allow the service URL to be called in order to set any required identifiers e.g. extra cookies.<!-- -->The request respects the <code>anonymousTracking</code> option, including the SP-Anonymous header if needed, and any additional custom headers from the customHeaders option. |
26+
| [idService?](./react-native-tracker.emitterconfigurationbase.idservice.md) | string | <i>(Optional)</i> |
2627
| [keepalive?](./react-native-tracker.emitterconfigurationbase.keepalive.md) | boolean | <i>(Optional)</i> Indicates that the request should be allowed to outlive the webpage that initiated it. Enables collector requests to complete even if the page is closed or navigated away from. Note: Browsers put a limit on keepalive requests of 64KB. In case of multiple keepalive requests in parallel (may happen in case of multiple trackers), the limit is shared. |
2728
| [maxGetBytes?](./react-native-tracker.emitterconfigurationbase.maxgetbytes.md) | number | <i>(Optional)</i> The max size a GET request (its complete URL) can be. Requests over this size will be tried as a POST request. |
2829
| [maxPostBytes?](./react-native-tracker.emitterconfigurationbase.maxpostbytes.md) | number | <i>(Optional)</i> The max size a POST request can be before the tracker will force send it Also dictates the max size of a POST request before a batch of events is split into multiple requests |

0 commit comments

Comments
 (0)