Skip to content

Commit

Permalink
docs: s/View/view/
Browse files Browse the repository at this point in the history
  • Loading branch information
@koba04
koba04 committed Feb 13, 2020
1 parent 219ac81 commit aa5642d
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions packages/rest-api-client/docs/app.md
View file
Expand Up @@ -499,7 +499,7 @@ Gets the view settings of an app.
| Name | Type | Description |
| ---------------------------- | :-----: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| views | Object | An object listing view information. |
| views.{viewName}.type | String | The type of view.<ul><li>`LIST`: List View</li><li>`CALENDAR`: Calendar View</li><li>`CUSTOM`: Custom View</li></ul> |
| views.{viewName}.type | String | The type of view.<ul><li>`LIST`: List view</li><li>`CALENDAR`: Calendar view</li><li>`CUSTOM`: Custom view</li></ul> |
| views.{viewName}.builtinType | String | The type of the built-in view.<ul><li>`ASSIGNEE`: The "Assigned to me" view.<br />(This list is automatically created if the process management settings have been enabled in the app.)<br />Currently, there are no other types of built-in views. |
| views.{viewName}.date | String | The field code set for the date field.<br />Responded for calendar views. |
| views.{viewName}.fields | Array | The list of field codes for the fields displayed in the view.<br />Responded for list views. |
Expand All @@ -511,7 +511,7 @@ Gets the view settings of an app.
| views.{viewName}.pager | Boolean | It indicates whether the pagination settings is enabled.<br />Responded for custom views. |
| views.{viewName}.device | String | The scope of where the view is displayed.<ul><li>`DESKTOP`: Display only on desktop</li><li>`ANY`: Display on both desktop and mobile</li></ul> |
| views.{viewName}.sort | String | The sort order as a query.<br />Check [Query Options](https://developer.kintone.io/hc/en-us/articles/360019245194#options) for more information on query formats. |
| views.{viewName}.title | String | The field code set for the Title Field.<br />Responded for calendar Views. |
| views.{viewName}.title | String | The field code set for the Title Field.<br />Responded for calendar views. |
| revision | String | The revision number of the app settings. |

#### Reference
Expand All @@ -530,12 +530,12 @@ Updates the view settings of an app.
| views | Object | Yes | An object of data of views. |
| views.{viewName} | Object | Yes | The view name of the view to add changes to.<br />If a view name that does exist is specified, a new view with this name will be created. |
| views.{viewName}.index | String | Yes | The display order of the view, in the list of views, specified with a number. The list of views will be displayed in ascending order. |
| views.{viewName}.type | String | Yes | The type of view.<br /><ul><li>`LIST`: List View</li><li>`CALENDAR`: Calendar View</li><li>`CUSTOM`: Custom View</li></ul> |
| views.{viewName}.type | String | Yes | The type of view.<br /><ul><li>`LIST`: List view</li><li>`CALENDAR`: Calendar view</li><li>`CUSTOM`: Custom view</li></ul> |
| views.{viewName}.name | String | Conditionally<br />Required | The name of the view.<br />The maximum character limit is 64.<br />Required, if `views.{viewName}` is a new view. In this case, specify the same new view name for this parameter. |
| views.{viewName}.fields | Array\<String\> | | Used for list views.<br />The list of fields to be displayed in the list.<br />Specify fields by their field codes. |
| views.{viewName}.date | String | | Used for calendar Views.<br />The field to be used as the "Date Field" of the calendar View.<br />Specify a date type field by their field code.<br />If ignored, the created datetime field will be set. |
| views.{viewName}.title | String | | Used for calendar Views.<br />The field to be used as the "Title Field" of the calendar View.<br />Specify a text type field by their fieldcode.<br />If ignored, the record number field will be set. |
| views.{viewName}.html | String | | Used for Custom Views.<br />The HTML code to set for the Custom View. |
| views.{viewName}.date | String | | Used for calendar views.<br />The field to be used as the "Date Field" of the calendar view.<br />Specify a date type field by their field code.<br />If ignored, the created datetime field will be set. |
| views.{viewName}.title | String | | Used for calendar views.<br />The field to be used as the "Title Field" of the calendar view.<br />Specify a text type field by their fieldcode.<br />If ignored, the record number field will be set. |
| views.{viewName}.html | String | | Used for Custom views.<br />The HTML code to set for the Custom view. |
| views.{viewName}.pager | Boolean | | It indicates whether the pagination settings is enabled. the default is `true`. |
| views.{viewName}.device | String | | The scope of where the view is displayed.<br />If this parameter is not specified, the default is `DESKTOP`. If view settings are updated without specifying this parameter, this parameter does not change.<ul><li>`DESKTOP`: Display only on desktop</li><li>`ANY`: Display on both desktop and mobile</li></ul> |
| views.{viewName}.filterCond | String | | The filter condition in a query format.<br />Check [Query Operators and Functions](https://developer.kintone.io/hc/en-us/articles/360019245194#optfunc) for more data on query formats. |
Expand Down

0 comments on commit aa5642d

Please sign in to comment.