Skip to content

Commit

Permalink
Add offset property to channels.history, groups.history, dm.history (R…
Browse files Browse the repository at this point in the history
…ocketChat#1055)

Signed-off-by: Eugene Bolshakov <[email protected]>
  • Loading branch information
xbolshe authored and MartinSchoeler committed Feb 20, 2019
1 parent c3f0711 commit f491e90
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions developer-guides/rest-api/channels/history/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Retrieves the messages from a channel.
| `latest` | `2016-09-30T13:42:25.304Z` | Optional <br> Default: now | The end of time range of messages to retrieve |
| `oldest` | `2016-05-30T13:42:25.304Z` | Optional <br> Default: _n/a_ | The start of the time range of messages to retrieve |
| `inclusive` | `true` | Optional <br> Default: `false` | Whether messages which land on latest and oldest should be included |
| `offset` | `10` | Optional <br> Default: `0` | The offset of the list messages to retrieve |
| `count` | `100` | Optional <br> Default: `20` | The amount of messages to retrieve |
| `unreads` | `false` | Optional <br> Default: `false` | Whether the amount of unreads should be included. |

Expand Down Expand Up @@ -89,4 +90,5 @@ curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \

| Version | Description |
| :--- | :--- |
| 0.75.0 | Added `offset` property |
| 0.47.0 | Added |
2 changes: 2 additions & 0 deletions developer-guides/rest-api/groups/history/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Retrieves the messages from a private group, only if you're part of the group.
| `latest` | `2016-09-30T13:42:25.304Z` | Optional <br> Default: now | The end of time range of messages to retrieve |
| `oldest` | `2016-05-30T13:42:25.304Z` | Optional <br> Default: _n/a_ | The start of the time range of messages to retrieve |
| `inclusive` | `true` | Optional <br> Default: `false` | Whether messages which land on latest and oldest should be included |
| `offset` | `10` | Optional <br> Default: `0` | The offset of the list messages to retrieve |
| `count` | `100` | Optional <br> Default: `20` | The amount of messages to retrieve |
| `unreads` | `false` | Optional <br> Default: `false` | Whether the amount of unreads should be included. |

Expand Down Expand Up @@ -89,4 +90,5 @@ curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \

| Version | Description |
| :--- | :--- |
| 0.75.0 | Added `offset` property |
| 0.48.0 | Added |
2 changes: 2 additions & 0 deletions developer-guides/rest-api/im/history/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Retrieves the messages from a direct message.
| `latest` | `2016-09-30T13:42:25.304Z` | Optional <br> Default: now | The end of time range of messages to retrieve |
| `oldest` | `2016-05-30T13:42:25.304Z` | Optional <br> Default: _n/a_ | The start of the time range of messages to retrieve |
| `inclusive` | `true` | Optional <br> Default: `false` | Whether messages which land on latest and oldest should be included |
| `offset` | `10` | Optional <br> Default: `0` | The offset of the list messages to retrieve |
| `count` | `100` | Optional <br> Default: `20` | The amount of messages to retrieve |
| `unreads` | `false` | Optional <br> Default: `false` | Whether the amount of unreads should be included. |

Expand Down Expand Up @@ -89,4 +90,5 @@ curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \

| Version | Description |
| :--- | :--- |
| 0.75.0 | Added `offset` property |
| 0.48.0 | Added |

0 comments on commit f491e90

Please sign in to comment.