| Package | Description |
|---|---|
| io.swagger.client | |
| io.swagger.client.api |
| Modifier and Type | Method and Description |
|---|---|
<T> ApiResponse<T> |
ApiClient.execute(com.squareup.okhttp.Call call)
|
<T> ApiResponse<T> |
ApiClient.execute(com.squareup.okhttp.Call call,
Type returnType)
Execute HTTP call and deserialize the HTTP response body into the given return type.
|
| Modifier and Type | Method and Description |
|---|---|
ApiResponse<File> |
UploadAndDownloadFilesApi.orgNameAppNameChatfilesFilestreamGetWithHttpInfo(String orgName,
String appName,
String authorization,
String filestream,
String shareSecret)
Download the voice / image file
Important: It should be noted that the need to bring in the HTTP header to return the share-secret and the current login user's token can be downloaded, and pay attention to the implementation of the header accept value needs to be set to application / octet-stream.
|
ApiResponse<String> |
UploadAndDownloadFilesApi.orgNameAppNameChatfilesPostWithHttpInfo(String orgName,
String appName,
String authorization,
File file,
Boolean restrictAccess)
Upload a File
Warning: File cannot be over 10MB, otherwise will fail.
|
ApiResponse<File> |
UploadAndDownloadFilesApi.orgNameAppNameChatfilesUuidGetWithHttpInfo(String orgName,
String appName,
String authorization,
String uuid,
String shareSecret,
Boolean thumbnail)
Download a thumbnail
Important: 1.
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGetWithHttpInfo(String orgName,
String appName,
String authorization,
String limit,
String cursor)
Get All the Groups
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdBlocksUsersGetWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId)
Get Group Blocked Users
Get the blacklist of blocked users.
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdBlocksUsersPostWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId,
UserNames body)
Block Group Members in Batch
Block multiple group members by adding the users to the group blacklist.
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdBlocksUsersUsernameDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId,
String username)
Unblock a Group Member
Unblock group member by removing the user from group blacklist.
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdBlocksUsersUsernamePostWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId,
String username)
Block a Group Member
Block a group member by adding the user to the group blacklist.
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdBlocksUsersUsernamesDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId,
String usernames)
Unblock Group Members in Batch
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId)
Delete a Group
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdPutWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId,
ModifyGroup body)
Update Group Details
The message body only allows groupname, description, and maxusers.
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupidPutWithHttpInfo(String orgName,
String appName,
String authorization,
String groupid,
NewOwner body)
Update Group Owner
Transfer group ownership by changing owner.
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdsGetWithHttpInfo(String orgName,
String appName,
String authorization,
String groupIds)
Get Group(s) Details
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdUsersGetWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId)
Get a List of Members of Group
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdUsersMembersDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId,
String members)
Remove multiple Member from the Group
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdUsersPostWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId,
UserNames body)
Add Multiple Members to Group
Warning: Add max 60 members once at a time.
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdUsersUsernameDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId,
String username)
Remove a Member from the Group
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsGroupIdUsersUsernamePostWithHttpInfo(String orgName,
String appName,
String authorization,
String groupId,
String username)
Add a Member to Group
|
ApiResponse<String> |
GroupsApi.orgNameAppNameChatgroupsPostWithHttpInfo(String orgName,
String appName,
String authorization,
Group body)
Create a Group
Group settings: 1.
|
ApiResponse<String> |
ChatHistoryApi.orgNameAppNameChatmessagesGetWithHttpInfo(String orgName,
String appName,
String authorization,
String ql,
String limit,
String cursor)
Get Message History
|
ApiResponse<String> |
ChatHistoryApi.orgNameAppNameChatmessagesTimeGetWithHttpInfo(String orgName,
String appName,
String authorization,
String time)
Get Message History by Hour
|
ApiResponse<String> |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String chatroomId)
Delete a Chat Room
|
ApiResponse<String> |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdGetWithHttpInfo(String orgName,
String appName,
String authorization,
String chatroomId)
Get Chat Room Details
|
ApiResponse<String> |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdPutWithHttpInfo(String orgName,
String appName,
String authorization,
String chatroomId,
ModifyChatroom body)
Update Chat Room Details
|
ApiResponse<String> |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdUsersPostWithHttpInfo(String orgName,
String appName,
String authorization,
String chatroomId,
UserNames content)
Add Chat Room Members in Batch
Add max 60 group members at a time.
|
ApiResponse<String> |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdUsersUsernameDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String chatroomId,
String username)
Remove a Chat Room Member
|
ApiResponse<String> |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdUsersUsernamePostWithHttpInfo(String orgName,
String appName,
String authorization,
String chatroomId,
String username)
Add a Chat Room Member
|
ApiResponse<String> |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdUsersUsernamesDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String chatroomId,
String usernames)
Remove Chat Room Members in Batch
|
ApiResponse<String> |
ChatRoomsApi.orgNameAppNameChatroomsGetWithHttpInfo(String orgName,
String appName,
String authorization)
Get All the Chat Rooms
|
ApiResponse<String> |
ChatRoomsApi.orgNameAppNameChatroomsPostWithHttpInfo(String orgName,
String appName,
String authorization,
Chatroom body)
Create a Chat Room
|
ApiResponse<String> |
MessagesApi.orgNameAppNameMessagesPostWithHttpInfo(String orgName,
String appName,
String authorization,
Msg body)
Send a Message
Send a message to user(s) and group(s).
|
ApiResponse<String> |
AuthenticationApi.orgNameAppNameTokenPostWithHttpInfo(String orgName,
String appName,
Token body)
Request an Authentication Token
All of the Hyphenate API endpoints requires authentication token for session, unless specified otherwise.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String limit,
String cursor)
Delete Users in Batch
Delete total number of N user accounts in batch.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersGetWithHttpInfo(String orgName,
String appName,
String authorization,
String limit,
String cursor)
Get Users in Batch
Get a list of users
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersOwnerUsernameBlocksUsersBlockedUsernameDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String ownerUsername,
String blockedUsername)
Unblock User(s)
Unblock one or multiple users by removing them from blacklist.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersOwnerUsernameBlocksUsersGetWithHttpInfo(String orgName,
String appName,
String authorization,
String ownerUsername)
Get a List of Blocked Users
Get a List of Blocked Users by the user.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersOwnerUsernameBlocksUsersPostWithHttpInfo(String orgName,
String appName,
String authorization,
String ownerUsername,
UserNames usernames)
Block User(s)
Block one or multiple users by adding to blacklist.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersOwnerUsernameContactsUsersFriendUsernameDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String ownerUsername,
String friendUsername)
Remove Contact from User
Remove contact from user's contact list.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersOwnerUsernameContactsUsersFriendUsernamePostWithHttpInfo(String orgName,
String appName,
String authorization,
String ownerUsername,
String friendUsername)
Add Contact for User
Add contact for user.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersOwnerUsernameContactsUsersGetWithHttpInfo(String orgName,
String appName,
String authorization,
String ownerUsername)
Get a List of Contacts
Get user's contact list
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersOwnerUsernameOfflineMsgCountGetWithHttpInfo(String orgName,
String appName,
String authorization,
String ownerUsername)
Get Offline Message Count
Get the number of offline messages
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersPostWithHttpInfo(String orgName,
String appName,
RegisterUsers body,
String authorization)
Create a User
Register an IM user account respects to org and app keys.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersUsernameActivatePostWithHttpInfo(String orgName,
String appName,
String authorization,
String username)
Activate User Account
Activate a deactivated user account.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersUsernameDeactivatePostWithHttpInfo(String orgName,
String appName,
String authorization,
String username)
Deactivate User Account
Deactivate a user account.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersUsernameDeleteWithHttpInfo(String orgName,
String appName,
String authorization,
String username)
Delete a User
Warning: Delete a user will also delete the group and chat room if the specified user is the admin of the group and chat room.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersUsernameDisconnectGetWithHttpInfo(String orgName,
String appName,
String authorization,
String username)
Logout User
Force logout a user
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersUsernameGetWithHttpInfo(String orgName,
String appName,
String authorization,
String username)
Get a User
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersUsernameJoinedChatgroupsGetWithHttpInfo(String orgName,
String appName,
String authorization,
String username)
Get a List of Groups of User Joined
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersUsernameJoinedChatroomsGetWithHttpInfo(String orgName,
String appName,
String authorization,
String username)
Get All the Chat Rooms of User Joined
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersUsernameOfflineMsgStatusMsgIdGetWithHttpInfo(String orgName,
String appName,
String authorization,
String username,
String msgId)
Get Offline Message Status
Get offline message status via message ID.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersUsernamePasswordPutWithHttpInfo(String orgName,
String appName,
String username,
NewPassword body,
String authorization)
Reset User's Password
To enhance security, we recommend update user's Hyphenate IM user account password if the user's app password on developer server is updated.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersUsernamePutWithHttpInfo(String orgName,
String appName,
String username,
Nickname body,
String authorization)
Update User's APNs Display Name
Update user's APNs display name for iOS push notification.
|
ApiResponse<String> |
UsersApi.orgNameAppNameUsersUsernameStatusGetWithHttpInfo(String orgName,
String appName,
String authorization,
String username)
Get User Online Status
|
Copyright © 2017. All rights reserved.