summaryrefslogtreecommitdiff
path: root/jb-ui/src/api_fsb/docs/SessionConfig.md
blob: 1df61d8c420dbdc34571c24754796ac6bf3b47ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# SessionConfig

Stores configuration related to the Session, a session being a users experience attempting to do work.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**max_session_len** | **number** | The amount of time (in seconds) that a respondent may spend attempting to get into a survey within a session.If NULL, there is no limit. | [optional] [default to 600]
**max_session_hard_retry** | **number** | The number of surveys that a respondent may attempt within a session before the session is terminated. | [optional] [default to 5]
**min_payout** | **string** | The minimum amount the user should be paid for a complete. If          no payout transformation is defined, the value is based on the BP\'s payout.          If a payout transformation is defined, the min_payout is applied on the          user\'s payout. Note, this is separate and distinct from the payout          transformation\'s min payout. The payout transformation\'s min_payout does not          care what the task\'s actual payout was. This min_payout will prevent         the user from being show any tasks that would pay below this amount. | [optional] [default to '0.14']

## Example

```typescript
import { SessionConfig } from './api';

const instance: SessionConfig = {
    max_session_len,
    max_session_hard_retry,
    min_payout,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)