# NotificationApi All URIs are relative to *http://localhost/api/v1* Method | HTTP request | Description ------------- | ------------- | ------------- [**notifyGetList**](NotificationApi.md#notifyGetList) | **GET** /notifications | List users's notification threads [**notifyGetRepoList**](NotificationApi.md#notifyGetRepoList) | **GET** /repos/{owner}/{repo}/notifications | List users's notification threads on a specific repo [**notifyGetThread**](NotificationApi.md#notifyGetThread) | **GET** /notifications/threads/{id} | Get notification thread by ID [**notifyNewAvailable**](NotificationApi.md#notifyNewAvailable) | **GET** /notifications/new | Check if unread notifications exist [**notifyReadList**](NotificationApi.md#notifyReadList) | **PUT** /notifications | Mark notification threads as read, pinned or unread [**notifyReadRepoList**](NotificationApi.md#notifyReadRepoList) | **PUT** /repos/{owner}/{repo}/notifications | Mark notification threads as read, pinned or unread on a specific repo [**notifyReadThread**](NotificationApi.md#notifyReadThread) | **PATCH** /notifications/threads/{id} | Mark notification thread as read by ID # **notifyGetList** > List<NotificationThread> notifyGetList(all, statusTypes, since, before, page, limit) List users's notification threads ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.NotificationApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); NotificationApi apiInstance = new NotificationApi(defaultClient); String all = "all_example"; // String | If true, show notifications marked as read. Default value is false List statusTypes = Arrays.asList(); // List | Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. OffsetDateTime since = OffsetDateTime.now(); // OffsetDateTime | Only show notifications updated after the given time. This is a timestamp in RFC 3339 format OffsetDateTime before = OffsetDateTime.now(); // OffsetDateTime | Only show notifications updated before the given time. This is a timestamp in RFC 3339 format Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.notifyGetList(all, statusTypes, since, before, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling NotificationApi#notifyGetList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **all** | **String**| If true, show notifications marked as read. Default value is false | [optional] **statusTypes** | [**List<String>**](String.md)| Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. | [optional] **since** | **OffsetDateTime**| Only show notifications updated after the given time. This is a timestamp in RFC 3339 format | [optional] **before** | **OffsetDateTime**| Only show notifications updated before the given time. This is a timestamp in RFC 3339 format | [optional] **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<NotificationThread>**](NotificationThread.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | NotificationThreadList | - | # **notifyGetRepoList** > List<NotificationThread> notifyGetRepoList(owner, repo, all, statusTypes, since, before, page, limit) List users's notification threads on a specific repo ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.NotificationApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); NotificationApi apiInstance = new NotificationApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String all = "all_example"; // String | If true, show notifications marked as read. Default value is false List statusTypes = Arrays.asList(); // List | Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned OffsetDateTime since = OffsetDateTime.now(); // OffsetDateTime | Only show notifications updated after the given time. This is a timestamp in RFC 3339 format OffsetDateTime before = OffsetDateTime.now(); // OffsetDateTime | Only show notifications updated before the given time. This is a timestamp in RFC 3339 format Integer page = 56; // Integer | page number of results to return (1-based) Integer limit = 56; // Integer | page size of results try { List result = apiInstance.notifyGetRepoList(owner, repo, all, statusTypes, since, before, page, limit); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling NotificationApi#notifyGetRepoList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **all** | **String**| If true, show notifications marked as read. Default value is false | [optional] **statusTypes** | [**List<String>**](String.md)| Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned | [optional] **since** | **OffsetDateTime**| Only show notifications updated after the given time. This is a timestamp in RFC 3339 format | [optional] **before** | **OffsetDateTime**| Only show notifications updated before the given time. This is a timestamp in RFC 3339 format | [optional] **page** | **Integer**| page number of results to return (1-based) | [optional] **limit** | **Integer**| page size of results | [optional] ### Return type [**List<NotificationThread>**](NotificationThread.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | NotificationThreadList | - | # **notifyGetThread** > NotificationThread notifyGetThread(id) Get notification thread by ID ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.NotificationApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); NotificationApi apiInstance = new NotificationApi(defaultClient); String id = "id_example"; // String | id of notification thread try { NotificationThread result = apiInstance.notifyGetThread(id); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling NotificationApi#notifyGetThread"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| id of notification thread | ### Return type [**NotificationThread**](NotificationThread.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | NotificationThread | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| **404** | APINotFound is a not found empty response | - | # **notifyNewAvailable** > NotificationCount notifyNewAvailable() Check if unread notifications exist ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.NotificationApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); NotificationApi apiInstance = new NotificationApi(defaultClient); try { NotificationCount result = apiInstance.notifyNewAvailable(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling NotificationApi#notifyNewAvailable"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**NotificationCount**](NotificationCount.md) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json, text/html ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Number of unread notifications | - | # **notifyReadList** > notifyReadList(lastReadAt, all, statusTypes, toStatus) Mark notification threads as read, pinned or unread ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.NotificationApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); NotificationApi apiInstance = new NotificationApi(defaultClient); OffsetDateTime lastReadAt = OffsetDateTime.now(); // OffsetDateTime | Describes the last point that notifications were checked. Anything updated since this time will not be updated. String all = "all_example"; // String | If true, mark all notifications on this repo. Default value is false List statusTypes = Arrays.asList(); // List | Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. String toStatus = "toStatus_example"; // String | Status to mark notifications as, Defaults to read. try { apiInstance.notifyReadList(lastReadAt, all, statusTypes, toStatus); } catch (ApiException e) { System.err.println("Exception when calling NotificationApi#notifyReadList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **lastReadAt** | **OffsetDateTime**| Describes the last point that notifications were checked. Anything updated since this time will not be updated. | [optional] **all** | **String**| If true, mark all notifications on this repo. Default value is false | [optional] **statusTypes** | [**List<String>**](String.md)| Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. | [optional] **toStatus** | **String**| Status to mark notifications as, Defaults to read. | [optional] ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **205** | APIEmpty is an empty response | - | # **notifyReadRepoList** > notifyReadRepoList(owner, repo, all, statusTypes, toStatus, lastReadAt) Mark notification threads as read, pinned or unread on a specific repo ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.NotificationApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); NotificationApi apiInstance = new NotificationApi(defaultClient); String owner = "owner_example"; // String | owner of the repo String repo = "repo_example"; // String | name of the repo String all = "all_example"; // String | If true, mark all notifications on this repo. Default value is false List statusTypes = Arrays.asList(); // List | Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. String toStatus = "toStatus_example"; // String | Status to mark notifications as. Defaults to read. OffsetDateTime lastReadAt = OffsetDateTime.now(); // OffsetDateTime | Describes the last point that notifications were checked. Anything updated since this time will not be updated. try { apiInstance.notifyReadRepoList(owner, repo, all, statusTypes, toStatus, lastReadAt); } catch (ApiException e) { System.err.println("Exception when calling NotificationApi#notifyReadRepoList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **owner** | **String**| owner of the repo | **repo** | **String**| name of the repo | **all** | **String**| If true, mark all notifications on this repo. Default value is false | [optional] **statusTypes** | [**List<String>**](String.md)| Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. | [optional] **toStatus** | **String**| Status to mark notifications as. Defaults to read. | [optional] **lastReadAt** | **OffsetDateTime**| Describes the last point that notifications were checked. Anything updated since this time will not be updated. | [optional] ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **205** | APIEmpty is an empty response | - | # **notifyReadThread** > notifyReadThread(id, toStatus) Mark notification thread as read by ID ### Example ```java // Import classes: import io.gitea.ApiClient; import io.gitea.ApiException; import io.gitea.Configuration; import io.gitea.auth.*; import io.gitea.models.*; import io.gitea.api.NotificationApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = Configuration.getDefaultApiClient(); defaultClient.setBasePath("http://localhost/api/v1"); // Configure API key authorization: AccessToken ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken"); AccessToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AccessToken.setApiKeyPrefix("Token"); // Configure API key authorization: AuthorizationHeaderToken ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken"); AuthorizationHeaderToken.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //AuthorizationHeaderToken.setApiKeyPrefix("Token"); // Configure HTTP basic authorization: BasicAuth HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth"); BasicAuth.setUsername("YOUR USERNAME"); BasicAuth.setPassword("YOUR PASSWORD"); // Configure API key authorization: SudoHeader ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader"); SudoHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoHeader.setApiKeyPrefix("Token"); // Configure API key authorization: SudoParam ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam"); SudoParam.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //SudoParam.setApiKeyPrefix("Token"); // Configure API key authorization: TOTPHeader ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader"); TOTPHeader.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //TOTPHeader.setApiKeyPrefix("Token"); // Configure API key authorization: Token ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token"); Token.setApiKey("YOUR API KEY"); // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.setApiKeyPrefix("Token"); NotificationApi apiInstance = new NotificationApi(defaultClient); String id = "id_example"; // String | id of notification thread String toStatus = "\"read\""; // String | Status to mark notifications as try { apiInstance.notifyReadThread(id, toStatus); } catch (ApiException e) { System.err.println("Exception when calling NotificationApi#notifyReadThread"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **id** | **String**| id of notification thread | **toStatus** | **String**| Status to mark notifications as | [optional] [default to "read"] ### Return type null (empty response body) ### Authorization [AccessToken](../README.md#AccessToken), [AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken), [BasicAuth](../README.md#BasicAuth), [SudoHeader](../README.md#SudoHeader), [SudoParam](../README.md#SudoParam), [TOTPHeader](../README.md#TOTPHeader), [Token](../README.md#Token) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| **205** | APIEmpty is an empty response | - | **403** | APIForbiddenError is a forbidden error response | * message -
* url -
| **404** | APINotFound is a not found empty response | - |