mirror of
https://codeberg.org/timelimit/timelimit-server.git
synced 2025-10-03 17:59:24 +02:00
163 lines
7.2 KiB
Markdown
163 lines
7.2 KiB
Markdown
# ClientPushChangesRequest Schema
|
|
|
|
```txt
|
|
https://timelimit.io/ClientPushChangesRequest
|
|
```
|
|
|
|
|
|
|
|
|
|
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
|
| :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------------------------------- |
|
|
| Can be instantiated | Yes | Unknown status | No | Forbidden | Forbidden | none | [ClientPushChangesRequest.schema.json](ClientPushChangesRequest.schema.json "open original schema") |
|
|
|
|
## ClientPushChangesRequest Type
|
|
|
|
`object` ([ClientPushChangesRequest](clientpushchangesrequest.md))
|
|
|
|
# ClientPushChangesRequest Properties
|
|
|
|
| Property | Type | Required | Nullable | Defined by |
|
|
| :---------------------------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| [deviceAuthToken](#deviceauthtoken) | `string` | Required | cannot be null | [ClientPushChangesRequest](clientpushchangesrequest-properties-deviceauthtoken.md "https://timelimit.io/ClientPushChangesRequest#/properties/deviceAuthToken") |
|
|
| [actions](#actions) | `array` | Required | cannot be null | [ClientPushChangesRequest](clientpushchangesrequest-properties-actions.md "https://timelimit.io/ClientPushChangesRequest#/properties/actions") |
|
|
|
|
## deviceAuthToken
|
|
|
|
|
|
|
|
|
|
`deviceAuthToken`
|
|
|
|
- is required
|
|
- Type: `string`
|
|
- cannot be null
|
|
- defined in: [ClientPushChangesRequest](clientpushchangesrequest-properties-deviceauthtoken.md "https://timelimit.io/ClientPushChangesRequest#/properties/deviceAuthToken")
|
|
|
|
### deviceAuthToken Type
|
|
|
|
`string`
|
|
|
|
## actions
|
|
|
|
|
|
|
|
|
|
`actions`
|
|
|
|
- is required
|
|
- Type: `object[]` ([ClientPushChangesRequestAction](clientpushchangesrequest-definitions-clientpushchangesrequestaction.md))
|
|
- cannot be null
|
|
- defined in: [ClientPushChangesRequest](clientpushchangesrequest-properties-actions.md "https://timelimit.io/ClientPushChangesRequest#/properties/actions")
|
|
|
|
### actions Type
|
|
|
|
`object[]` ([ClientPushChangesRequestAction](clientpushchangesrequest-definitions-clientpushchangesrequestaction.md))
|
|
|
|
# ClientPushChangesRequest Definitions
|
|
|
|
## Definitions group ClientPushChangesRequestAction
|
|
|
|
Reference this group by using
|
|
|
|
```json
|
|
{"$ref":"https://timelimit.io/ClientPushChangesRequest#/definitions/ClientPushChangesRequestAction"}
|
|
```
|
|
|
|
| Property | Type | Required | Nullable | Defined by |
|
|
| :-------------------------------- | -------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| [encodedAction](#encodedaction) | `string` | Required | cannot be null | [ClientPushChangesRequest](clientpushchangesrequest-definitions-clientpushchangesrequestaction-properties-encodedaction.md "https://timelimit.io/ClientPushChangesRequest#/definitions/ClientPushChangesRequestAction/properties/encodedAction") |
|
|
| [sequenceNumber](#sequencenumber) | `number` | Required | cannot be null | [ClientPushChangesRequest](clientpushchangesrequest-definitions-clientpushchangesrequestaction-properties-sequencenumber.md "https://timelimit.io/ClientPushChangesRequest#/definitions/ClientPushChangesRequestAction/properties/sequenceNumber") |
|
|
| [integrity](#integrity) | `string` | Required | cannot be null | [ClientPushChangesRequest](clientpushchangesrequest-definitions-clientpushchangesrequestaction-properties-integrity.md "https://timelimit.io/ClientPushChangesRequest#/definitions/ClientPushChangesRequestAction/properties/integrity") |
|
|
| [type](#type) | `string` | Required | cannot be null | [ClientPushChangesRequest](clientpushchangesrequest-definitions-clientpushchangesrequestaction-properties-type.md "https://timelimit.io/ClientPushChangesRequest#/definitions/ClientPushChangesRequestAction/properties/type") |
|
|
| [userId](#userid) | `string` | Required | cannot be null | [ClientPushChangesRequest](clientpushchangesrequest-definitions-clientpushchangesrequestaction-properties-userid.md "https://timelimit.io/ClientPushChangesRequest#/definitions/ClientPushChangesRequestAction/properties/userId") |
|
|
|
|
### encodedAction
|
|
|
|
|
|
|
|
|
|
`encodedAction`
|
|
|
|
- is required
|
|
- Type: `string`
|
|
- cannot be null
|
|
- defined in: [ClientPushChangesRequest](clientpushchangesrequest-definitions-clientpushchangesrequestaction-properties-encodedaction.md "https://timelimit.io/ClientPushChangesRequest#/definitions/ClientPushChangesRequestAction/properties/encodedAction")
|
|
|
|
#### encodedAction Type
|
|
|
|
`string`
|
|
|
|
### sequenceNumber
|
|
|
|
|
|
|
|
|
|
`sequenceNumber`
|
|
|
|
- is required
|
|
- Type: `number`
|
|
- cannot be null
|
|
- defined in: [ClientPushChangesRequest](clientpushchangesrequest-definitions-clientpushchangesrequestaction-properties-sequencenumber.md "https://timelimit.io/ClientPushChangesRequest#/definitions/ClientPushChangesRequestAction/properties/sequenceNumber")
|
|
|
|
#### sequenceNumber Type
|
|
|
|
`number`
|
|
|
|
### integrity
|
|
|
|
|
|
|
|
|
|
`integrity`
|
|
|
|
- is required
|
|
- Type: `string`
|
|
- cannot be null
|
|
- defined in: [ClientPushChangesRequest](clientpushchangesrequest-definitions-clientpushchangesrequestaction-properties-integrity.md "https://timelimit.io/ClientPushChangesRequest#/definitions/ClientPushChangesRequestAction/properties/integrity")
|
|
|
|
#### integrity Type
|
|
|
|
`string`
|
|
|
|
### type
|
|
|
|
|
|
|
|
|
|
`type`
|
|
|
|
- is required
|
|
- Type: `string`
|
|
- cannot be null
|
|
- defined in: [ClientPushChangesRequest](clientpushchangesrequest-definitions-clientpushchangesrequestaction-properties-type.md "https://timelimit.io/ClientPushChangesRequest#/definitions/ClientPushChangesRequestAction/properties/type")
|
|
|
|
#### type Type
|
|
|
|
`string`
|
|
|
|
#### type Constraints
|
|
|
|
**enum**: the value of this property must be equal to one of the following values:
|
|
|
|
| Value | Explanation |
|
|
| :----------- | ----------- |
|
|
| `"appLogic"` | |
|
|
| `"child"` | |
|
|
| `"parent"` | |
|
|
|
|
### userId
|
|
|
|
|
|
|
|
|
|
`userId`
|
|
|
|
- is required
|
|
- Type: `string`
|
|
- cannot be null
|
|
- defined in: [ClientPushChangesRequest](clientpushchangesrequest-definitions-clientpushchangesrequestaction-properties-userid.md "https://timelimit.io/ClientPushChangesRequest#/definitions/ClientPushChangesRequestAction/properties/userId")
|
|
|
|
#### userId Type
|
|
|
|
`string`
|