Skip to content

Commit a9deb79

Browse files
jerry-jeonjerry-jeon
committed
Added the new functions related to the typing
startTyping stopTyping
1 parent a768639 commit a9deb79

File tree

348 files changed

+1022
-344
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

348 files changed

+1022
-344
lines changed

‎.gitignore‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,3 @@ hs_err_pid*
1919
target
2020
.gradle
2121
build
22-
23-
# etc
24-
README.md-e

‎.openapi-generator/FILES‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ docs/GcRegisterOperatorsData.md
8484
docs/GcRegisterOperatorsResponse.md
8585
docs/GcResetChatHistoryData.md
8686
docs/GcResetChatHistoryResponse.md
87+
docs/GcTypingIndicatorsData.md
8788
docs/GcUpdateBanByIdData.md
8889
docs/GcUpdateBanByIdResponse.md
8990
docs/GcUpdateChannelByUrlData.md
@@ -418,6 +419,7 @@ src/main/java/org/openapitools/client/model/GcRegisterOperatorsData.java
418419
src/main/java/org/openapitools/client/model/GcRegisterOperatorsResponse.java
419420
src/main/java/org/openapitools/client/model/GcResetChatHistoryData.java
420421
src/main/java/org/openapitools/client/model/GcResetChatHistoryResponse.java
422+
src/main/java/org/openapitools/client/model/GcTypingIndicatorsData.java
421423
src/main/java/org/openapitools/client/model/GcUpdateBanByIdData.java
422424
src/main/java/org/openapitools/client/model/GcUpdateBanByIdResponse.java
423425
src/main/java/org/openapitools/client/model/GcUpdateChannelByUrlData.java

‎api/openapi.yaml‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5337,6 +5337,89 @@ paths:
53375337
- Group channel
53385338
x-content-type: application/json
53395339
x-accepts: application/json
5340+
/v3/group_channels/{channel_url}/typing:
5341+
delete:
5342+
description: "## Stop typing indicators\n\nYou can stop showing a typing indicator\
5343+
\ using this API. To signal that a user is no longer typing, you can let the\
5344+
\ indicator disappear when the user sends a message or completely deletes\
5345+
\ the message text.\n\nhttps://sendbird.com/docs/chat/platform-api/v3/channel/managing-typing-indicators/stop-typing-indicators\n\
5346+
----------------------------\n\n `channel_url`\n Type: string\n Description:\
5347+
\ Specifies the URL of the channel to set typing indicators."
5348+
operationId: gcStopTypingIndicators
5349+
parameters:
5350+
- example: "{{API_TOKEN}}"
5351+
explode: false
5352+
in: header
5353+
name: Api-Token
5354+
required: false
5355+
schema:
5356+
type: string
5357+
style: simple
5358+
- explode: false
5359+
in: path
5360+
name: channel_url
5361+
required: true
5362+
schema:
5363+
type: string
5364+
style: simple
5365+
requestBody:
5366+
content:
5367+
application/json:
5368+
schema:
5369+
$ref: '#/components/schemas/gcTypingIndicatorsData'
5370+
responses:
5371+
"200":
5372+
content:
5373+
application/json:
5374+
schema:
5375+
$ref: '#/components/schemas/ocDeleteChannelByUrl_200_response'
5376+
description: Successful response
5377+
summary: Stop typing indicators
5378+
tags:
5379+
- Group channel
5380+
x-content-type: application/json
5381+
x-accepts: application/json
5382+
post:
5383+
description: "## Start typing indicators\n\nYou can start showing a typing indicator\
5384+
\ using this API. Seeing whether other users are typing can help a more interactive\
5385+
\ conversation environment by showing real-time engagement of other users.\n\
5386+
\nhttps://sendbird.com/docs/chat/platform-api/v3/channel/managing-typing-indicators/start-typing-indicators\n\
5387+
----------------------------\n\n `channel_url`\n Type: string\n Description:\
5388+
\ Specifies the URL of the channel to set typing indicators."
5389+
operationId: gcStartTypingIndicators
5390+
parameters:
5391+
- example: "{{API_TOKEN}}"
5392+
explode: false
5393+
in: header
5394+
name: Api-Token
5395+
required: false
5396+
schema:
5397+
type: string
5398+
style: simple
5399+
- explode: false
5400+
in: path
5401+
name: channel_url
5402+
required: true
5403+
schema:
5404+
type: string
5405+
style: simple
5406+
requestBody:
5407+
content:
5408+
application/json:
5409+
schema:
5410+
$ref: '#/components/schemas/gcTypingIndicatorsData'
5411+
responses:
5412+
"200":
5413+
content:
5414+
application/json:
5415+
schema:
5416+
$ref: '#/components/schemas/ocDeleteChannelByUrl_200_response'
5417+
description: Successful response
5418+
summary: Start typing indicators
5419+
tags:
5420+
- Group channel
5421+
x-content-type: application/json
5422+
x-accepts: application/json
53405423
/v3/group_channels/{channel_url}/ban:
53415424
get:
53425425
description: "## List banned users\n\nRetrieves a list of the banned users from\
@@ -20413,6 +20496,18 @@ components:
2041320496
- operator_ids
2041420497
title: gcRegisterOperatorsData
2041520498
type: object
20499+
gcTypingIndicatorsData:
20500+
properties:
20501+
user_ids:
20502+
description: Specifies an array of IDs of users who are to stop using the
20503+
typing indicator. You can list up to ten user IDs.
20504+
items:
20505+
type: string
20506+
type: array
20507+
required:
20508+
- user_ids
20509+
title: gcTypingIndicatorsData
20510+
type: object
2041620511
gcBanUserData:
2041720512
properties:
2041820513
channel_url:

‎docs/GcTypingIndicatorsData.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
3+
# GcTypingIndicatorsData
4+
5+
6+
## Properties
7+
8+
| Name | Type | Description | Notes |
9+
|------------ | ------------- | ------------- | -------------|
10+
|**userIds** | **List<String>** | Specifies an array of IDs of users who are to stop using the typing indicator. You can list up to ten user IDs. | |
11+
12+
13+

‎docs/GroupChannelApi.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ All URIs are relative to *https://api-APP_ID.sendbird.com*
1919
| [**gcListOperators**](GroupChannelApi.md#gcListOperators) | **GET** /v3/group_channels/{channel_url}/operators | List operators |
2020
| [**gcRegisterOperators**](GroupChannelApi.md#gcRegisterOperators) | **POST** /v3/group_channels/{channel_url}/operators | Register operators |
2121
| [**gcResetChatHistory**](GroupChannelApi.md#gcResetChatHistory) | **PUT** /v3/group_channels/{channel_url}/reset_user_history | Reset chat history |
22+
| [**gcStartTypingIndicators**](GroupChannelApi.md#gcStartTypingIndicators) | **POST** /v3/group_channels/{channel_url}/typing | Start typing indicators |
23+
| [**gcStopTypingIndicators**](GroupChannelApi.md#gcStopTypingIndicators) | **DELETE** /v3/group_channels/{channel_url}/typing | Stop typing indicators |
2224
| [**gcUnhideOrUnarchiveChannel**](GroupChannelApi.md#gcUnhideOrUnarchiveChannel) | **DELETE** /v3/group_channels/{channel_url}/hide | Unhide or unarchive a channel |
2325
| [**gcUpdateChannelByUrl**](GroupChannelApi.md#gcUpdateChannelByUrl) | **PUT** /v3/group_channels/{channel_url} | Update a channel |
2426
| [**gcViewChannelByUrl**](GroupChannelApi.md#gcViewChannelByUrl) | **GET** /v3/group_channels/{channel_url} | View a channel |
@@ -1353,6 +1355,168 @@ No authorization required
13531355
| **200** | Successful response | - |
13541356

13551357

1358+
## gcStartTypingIndicators
1359+
1360+
> OcDeleteChannelByUrl200Response gcStartTypingIndicators(channelUrl).apiToken(apiToken).gcTypingIndicatorsData(gcTypingIndicatorsData).execute();
1361+
1362+
Start typing indicators
1363+
1364+
## Start typing indicators
1365+
1366+
You can start showing a typing indicator using this API. Seeing whether other users are typing can help a more interactive conversation environment by showing real-time engagement of other users.
1367+
1368+
https://sendbird.com/docs/chat/platform-api/v3/channel/managing-typing-indicators/start-typing-indicators
1369+
----------------------------
1370+
1371+
`channel_url`
1372+
Type: string
1373+
Description: Specifies the URL of the channel to set typing indicators.
1374+
1375+
### Example
1376+
1377+
```java
1378+
// Import classes:
1379+
import org.sendbird.client.ApiClient;
1380+
import org.sendbird.client.ApiException;
1381+
import org.sendbird.client.Configuration;
1382+
import org.sendbird.client.model.*;
1383+
import org.sendbird.client.api.GroupChannelApi;
1384+
1385+
public class Example {
1386+
public static void main(String[] args) {
1387+
ApiClient defaultClient = Configuration.getDefaultApiClient();
1388+
defaultClient.setBasePath("https://api-APP_ID.sendbird.com");
1389+
1390+
GroupChannelApi apiInstance = new GroupChannelApi(defaultClient);
1391+
String channelUrl = "channelUrl_example"; // String |
1392+
String apiToken = "{{API_TOKEN}}"; // String |
1393+
GcTypingIndicatorsData gcTypingIndicatorsData = new GcTypingIndicatorsData(); // GcTypingIndicatorsData |
1394+
try {
1395+
OcDeleteChannelByUrl200Response result = api.gcStartTypingIndicators(channelUrl)
1396+
.apiToken(apiToken)
1397+
.gcTypingIndicatorsData(gcTypingIndicatorsData)
1398+
.execute();
1399+
System.out.println(result);
1400+
} catch (ApiException e) {
1401+
System.err.println("Exception when calling GroupChannelApi#gcStartTypingIndicators");
1402+
System.err.println("Status code: " + e.getCode());
1403+
System.err.println("Reason: " + e.getResponseBody());
1404+
System.err.println("Response headers: " + e.getResponseHeaders());
1405+
e.printStackTrace();
1406+
}
1407+
}
1408+
}
1409+
```
1410+
1411+
### Parameters
1412+
1413+
1414+
| Name | Type | Description | Notes |
1415+
|------------- | ------------- | ------------- | -------------|
1416+
| **channelUrl** | **String**| | |
1417+
| **apiToken** | **String**| | [optional] |
1418+
| **gcTypingIndicatorsData** | [**GcTypingIndicatorsData**](GcTypingIndicatorsData.md)| | [optional] |
1419+
1420+
### Return type
1421+
1422+
[**OcDeleteChannelByUrl200Response**](OcDeleteChannelByUrl200Response.md)
1423+
1424+
### Authorization
1425+
1426+
No authorization required
1427+
1428+
### HTTP request headers
1429+
1430+
- **Content-Type**: application/json
1431+
- **Accept**: application/json
1432+
1433+
### HTTP response details
1434+
| Status code | Description | Response headers |
1435+
|-------------|-------------|------------------|
1436+
| **200** | Successful response | - |
1437+
1438+
1439+
## gcStopTypingIndicators
1440+
1441+
> OcDeleteChannelByUrl200Response gcStopTypingIndicators(channelUrl).apiToken(apiToken).gcTypingIndicatorsData(gcTypingIndicatorsData).execute();
1442+
1443+
Stop typing indicators
1444+
1445+
## Stop typing indicators
1446+
1447+
You can stop showing a typing indicator using this API. To signal that a user is no longer typing, you can let the indicator disappear when the user sends a message or completely deletes the message text.
1448+
1449+
https://sendbird.com/docs/chat/platform-api/v3/channel/managing-typing-indicators/stop-typing-indicators
1450+
----------------------------
1451+
1452+
`channel_url`
1453+
Type: string
1454+
Description: Specifies the URL of the channel to set typing indicators.
1455+
1456+
### Example
1457+
1458+
```java
1459+
// Import classes:
1460+
import org.sendbird.client.ApiClient;
1461+
import org.sendbird.client.ApiException;
1462+
import org.sendbird.client.Configuration;
1463+
import org.sendbird.client.model.*;
1464+
import org.sendbird.client.api.GroupChannelApi;
1465+
1466+
public class Example {
1467+
public static void main(String[] args) {
1468+
ApiClient defaultClient = Configuration.getDefaultApiClient();
1469+
defaultClient.setBasePath("https://api-APP_ID.sendbird.com");
1470+
1471+
GroupChannelApi apiInstance = new GroupChannelApi(defaultClient);
1472+
String channelUrl = "channelUrl_example"; // String |
1473+
String apiToken = "{{API_TOKEN}}"; // String |
1474+
GcTypingIndicatorsData gcTypingIndicatorsData = new GcTypingIndicatorsData(); // GcTypingIndicatorsData |
1475+
try {
1476+
OcDeleteChannelByUrl200Response result = api.gcStopTypingIndicators(channelUrl)
1477+
.apiToken(apiToken)
1478+
.gcTypingIndicatorsData(gcTypingIndicatorsData)
1479+
.execute();
1480+
System.out.println(result);
1481+
} catch (ApiException e) {
1482+
System.err.println("Exception when calling GroupChannelApi#gcStopTypingIndicators");
1483+
System.err.println("Status code: " + e.getCode());
1484+
System.err.println("Reason: " + e.getResponseBody());
1485+
System.err.println("Response headers: " + e.getResponseHeaders());
1486+
e.printStackTrace();
1487+
}
1488+
}
1489+
}
1490+
```
1491+
1492+
### Parameters
1493+
1494+
1495+
| Name | Type | Description | Notes |
1496+
|------------- | ------------- | ------------- | -------------|
1497+
| **channelUrl** | **String**| | |
1498+
| **apiToken** | **String**| | [optional] |
1499+
| **gcTypingIndicatorsData** | [**GcTypingIndicatorsData**](GcTypingIndicatorsData.md)| | [optional] |
1500+
1501+
### Return type
1502+
1503+
[**OcDeleteChannelByUrl200Response**](OcDeleteChannelByUrl200Response.md)
1504+
1505+
### Authorization
1506+
1507+
No authorization required
1508+
1509+
### HTTP request headers
1510+
1511+
- **Content-Type**: application/json
1512+
- **Accept**: application/json
1513+
1514+
### HTTP response details
1515+
| Status code | Description | Response headers |
1516+
|-------------|-------------|------------------|
1517+
| **200** | Successful response | - |
1518+
1519+
13561520
## gcUnhideOrUnarchiveChannel
13571521

13581522
> OcDeleteChannelByUrl200Response gcUnhideOrUnarchiveChannel(channelUrl).userId(userId).apiToken(apiToken).shouldUnhideAll(shouldUnhideAll).execute();

‎src/main/java/org/openapitools/client/model/AbstractOpenApiSchema.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
/**
2525
* Abstract class for oneOf,anyOf schemas defined in OpenAPI spec
2626
*/
27-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
27+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-21T11:44:36.129327+09:00[Asia/Seoul]")
2828
public abstract class AbstractOpenApiSchema {
2929

3030
// store the actual instance of the schema/object

‎src/main/java/org/openapitools/client/model/AddApnsPushConfigurationData.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
AddApnsPushConfigurationData.JSON_PROPERTY_APNS_TYPE
4444
})
4545
@JsonTypeName("addApnsPushConfigurationData")
46-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
46+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-21T11:44:36.129327+09:00[Asia/Seoul]")
4747
public class AddApnsPushConfigurationData {
4848
public static final String JSON_PROPERTY_APNS_CERT = "apns_cert";
4949
private File apnsCert;

‎src/main/java/org/openapitools/client/model/AddApnsPushConfigurationResponse.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
AddApnsPushConfigurationResponse.JSON_PROPERTY_PUSH_CONFIGURATIONS
3939
})
4040
@JsonTypeName("addApnsPushConfigurationResponse")
41-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
41+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-21T11:44:36.129327+09:00[Asia/Seoul]")
4242
public class AddApnsPushConfigurationResponse {
4343
public static final String JSON_PROPERTY_PUSH_CONFIGURATIONS = "push_configurations";
4444
private List<AddApnsPushConfigurationResponsePushConfigurationsInner> pushConfigurations = null;

‎src/main/java/org/openapitools/client/model/AddApnsPushConfigurationResponsePushConfigurationsInner.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
AddApnsPushConfigurationResponsePushConfigurationsInner.JSON_PROPERTY_PUSH_SOUND
4646
})
4747
@JsonTypeName("addApnsPushConfigurationResponse_push_configurations_inner")
48-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
48+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-21T11:44:36.129327+09:00[Asia/Seoul]")
4949
public class AddApnsPushConfigurationResponsePushConfigurationsInner {
5050
public static final String JSON_PROPERTY_ID = "id";
5151
private String id;

‎src/main/java/org/openapitools/client/model/AddEmojiCategoriesResponse.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
AddEmojiCategoriesResponse.JSON_PROPERTY_EMOJI_CATEGORIES
3939
})
4040
@JsonTypeName("addEmojiCategoriesResponse")
41-
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-17T12:28:02.899+09:00[Asia/Seoul]")
41+
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2023-11-21T11:44:36.129327+09:00[Asia/Seoul]")
4242
public class AddEmojiCategoriesResponse {
4343
public static final String JSON_PROPERTY_EMOJI_CATEGORIES = "emoji_categories";
4444
private List<AddEmojiCategoriesResponseEmojiCategoriesInner> emojiCategories = null;

0 commit comments

Comments
 (0)