# ShareeUsers: Nextcloud Nextcloud Sharee Users
## Documentation
Users a sharee search matches, one row per user - a table function of search and item_type rather than a bulk table, per Sharees. Sharing with the account itself is excluded by the platform.
- Catalog: `Nextcloud`
- Schema: `Nextcloud`
- Label: Nextcloud Sharee Users
This is a read-only table function. The Nextcloud API may not support changing the data or the Invantive UniversalSQL driver for Nextcloud does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Nextcloud API.
## Parameters of Table Function
The following parameters can be used to control the behaviour of the table function `ShareeUsers`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
| Name | Data Type | Required | Default Value | Documentation |
|---|:---:|:---:|:---:|---|
| `item_type` | `varchar2` | ☐ | | What the result will be shared onto, such as file. |
| `search` | `varchar2` | ☐ | | Text to search for. |
## Columns of Table Function
The columns of the table function `ShareeUsers` are shown below. Each column has an SQL data type.
| Name | Data Type | Label | Required | Documentation |
|---|:---:|---|:---:|---|
| `icon` | `varchar2` | | ☐ | CSS icon class shown beside the entry. |
| `label` | `varchar2` | | ☑ | Display text of the search result. |
| `share_type` | `int32` | | ☐ | Numeric share type this entry would be shared with, such as 0 for a user or 1 for a group. |
| `share_with_display_name_unique` | `varchar2` | | ☐ | Display name disambiguated where two users would otherwise show identically. |
| `share_with` | `varchar2` | | ☐ | Identifier to pass as share_with when creating a share through Shares. |
| `status_clear_at` | `int64` | | ☐ | Epoch second the status clears at; null where it does not expire. |
| `status_icon` | `varchar2` | | ☐ | Emoji icon of the status. |
| `status_message` | `varchar2` | | ☐ | Free-text status message. |
| `status_status` | `varchar2` | | ☐ | User status, such as online or away; blank where the user status app answers nothing. |
| `subline` | `varchar2` | | ☐ | Secondary text shown beneath the label, such as an email address. |