| Package | Description |
|---|---|
| io.swagger.client | |
| io.swagger.client.api |
| Modifier and Type | Method and Description |
|---|---|
<T> void |
ApiClient.executeAsync(com.squareup.okhttp.Call call,
ApiCallback<T> callback)
|
<T> void |
ApiClient.executeAsync(com.squareup.okhttp.Call call,
Type returnType,
ApiCallback<T> callback)
Execute HTTP call asynchronously.
|
| Modifier and Type | Method and Description |
|---|---|
com.squareup.okhttp.Call |
UploadAndDownloadFilesApi.orgNameAppNameChatfilesFilestreamGetAsync(String orgName,
String appName,
String authorization,
String filestream,
String shareSecret,
ApiCallback<File> callback)
Download the voice / image file (asynchronously)
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.
|
com.squareup.okhttp.Call |
UploadAndDownloadFilesApi.orgNameAppNameChatfilesPostAsync(String orgName,
String appName,
String authorization,
File file,
Boolean restrictAccess,
ApiCallback<String> callback)
Upload a File (asynchronously)
Warning: File cannot be over 10MB, otherwise will fail.
|
com.squareup.okhttp.Call |
UploadAndDownloadFilesApi.orgNameAppNameChatfilesUuidGetAsync(String orgName,
String appName,
String authorization,
String uuid,
String shareSecret,
Boolean thumbnail,
ApiCallback<File> callback)
Download a thumbnail (asynchronously)
Important: 1.
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGetAsync(String orgName,
String appName,
String authorization,
String limit,
String cursor,
ApiCallback<String> callback)
Get All the Groups (asynchronously)
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdBlocksUsersGetAsync(String orgName,
String appName,
String authorization,
String groupId,
ApiCallback<String> callback)
Get Group Blocked Users (asynchronously)
Get the blacklist of blocked users.
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdBlocksUsersPostAsync(String orgName,
String appName,
String authorization,
String groupId,
UserNames body,
ApiCallback<String> callback)
Block Group Members in Batch (asynchronously)
Block multiple group members by adding the users to the group blacklist.
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdBlocksUsersUsernameDeleteAsync(String orgName,
String appName,
String authorization,
String groupId,
String username,
ApiCallback<String> callback)
Unblock a Group Member (asynchronously)
Unblock group member by removing the user from group blacklist.
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdBlocksUsersUsernamePostAsync(String orgName,
String appName,
String authorization,
String groupId,
String username,
ApiCallback<String> callback)
Block a Group Member (asynchronously)
Block a group member by adding the user to the group blacklist.
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdBlocksUsersUsernamesDeleteAsync(String orgName,
String appName,
String authorization,
String groupId,
String usernames,
ApiCallback<String> callback)
Unblock Group Members in Batch (asynchronously)
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdDeleteAsync(String orgName,
String appName,
String authorization,
String groupId,
ApiCallback<String> callback)
Delete a Group (asynchronously)
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdPutAsync(String orgName,
String appName,
String authorization,
String groupId,
ModifyGroup body,
ApiCallback<String> callback)
Update Group Details (asynchronously)
The message body only allows groupname, description, and maxusers.
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupidPutAsync(String orgName,
String appName,
String authorization,
String groupid,
NewOwner body,
ApiCallback<String> callback)
Update Group Owner (asynchronously)
Transfer group ownership by changing owner.
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdsGetAsync(String orgName,
String appName,
String authorization,
String groupIds,
ApiCallback<String> callback)
Get Group(s) Details (asynchronously)
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdUsersGetAsync(String orgName,
String appName,
String authorization,
String groupId,
ApiCallback<String> callback)
Get a List of Members of Group (asynchronously)
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdUsersMembersDeleteAsync(String orgName,
String appName,
String authorization,
String groupId,
String members,
ApiCallback<String> callback)
Remove multiple Member from the Group (asynchronously)
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdUsersPostAsync(String orgName,
String appName,
String authorization,
String groupId,
UserNames body,
ApiCallback<String> callback)
Add Multiple Members to Group (asynchronously)
Warning: Add max 60 members once at a time.
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdUsersUsernameDeleteAsync(String orgName,
String appName,
String authorization,
String groupId,
String username,
ApiCallback<String> callback)
Remove a Member from the Group (asynchronously)
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsGroupIdUsersUsernamePostAsync(String orgName,
String appName,
String authorization,
String groupId,
String username,
ApiCallback<String> callback)
Add a Member to Group (asynchronously)
|
com.squareup.okhttp.Call |
GroupsApi.orgNameAppNameChatgroupsPostAsync(String orgName,
String appName,
String authorization,
Group body,
ApiCallback<String> callback)
Create a Group (asynchronously)
Group settings: 1.
|
com.squareup.okhttp.Call |
ChatHistoryApi.orgNameAppNameChatmessagesGetAsync(String orgName,
String appName,
String authorization,
String ql,
String limit,
String cursor,
ApiCallback<String> callback)
Get Message History (asynchronously)
|
com.squareup.okhttp.Call |
ChatHistoryApi.orgNameAppNameChatmessagesTimeGetAsync(String orgName,
String appName,
String authorization,
String time,
ApiCallback<String> callback)
Get Message History by Hour (asynchronously)
|
com.squareup.okhttp.Call |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdDeleteAsync(String orgName,
String appName,
String authorization,
String chatroomId,
ApiCallback<String> callback)
Delete a Chat Room (asynchronously)
|
com.squareup.okhttp.Call |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdGetAsync(String orgName,
String appName,
String authorization,
String chatroomId,
ApiCallback<String> callback)
Get Chat Room Details (asynchronously)
|
com.squareup.okhttp.Call |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdPutAsync(String orgName,
String appName,
String authorization,
String chatroomId,
ModifyChatroom body,
ApiCallback<String> callback)
Update Chat Room Details (asynchronously)
|
com.squareup.okhttp.Call |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdUsersPostAsync(String orgName,
String appName,
String authorization,
String chatroomId,
UserNames content,
ApiCallback<String> callback)
Add Chat Room Members in Batch (asynchronously)
Add max 60 group members at a time.
|
com.squareup.okhttp.Call |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdUsersUsernameDeleteAsync(String orgName,
String appName,
String authorization,
String chatroomId,
String username,
ApiCallback<String> callback)
Remove a Chat Room Member (asynchronously)
|
com.squareup.okhttp.Call |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdUsersUsernamePostAsync(String orgName,
String appName,
String authorization,
String chatroomId,
String username,
ApiCallback<String> callback)
Add a Chat Room Member (asynchronously)
|
com.squareup.okhttp.Call |
ChatRoomsApi.orgNameAppNameChatroomsChatroomIdUsersUsernamesDeleteAsync(String orgName,
String appName,
String authorization,
String chatroomId,
String usernames,
ApiCallback<String> callback)
Remove Chat Room Members in Batch (asynchronously)
|
com.squareup.okhttp.Call |
ChatRoomsApi.orgNameAppNameChatroomsGetAsync(String orgName,
String appName,
String authorization,
ApiCallback<String> callback)
Get All the Chat Rooms (asynchronously)
|
com.squareup.okhttp.Call |
ChatRoomsApi.orgNameAppNameChatroomsPostAsync(String orgName,
String appName,
String authorization,
Chatroom body,
ApiCallback<String> callback)
Create a Chat Room (asynchronously)
|
com.squareup.okhttp.Call |
MessagesApi.orgNameAppNameMessagesPostAsync(String orgName,
String appName,
String authorization,
Msg body,
ApiCallback<String> callback)
Send a Message (asynchronously)
Send a message to user(s) and group(s).
|
com.squareup.okhttp.Call |
AuthenticationApi.orgNameAppNameTokenPostAsync(String orgName,
String appName,
Token body,
ApiCallback<String> callback)
Request an Authentication Token (asynchronously)
All of the Hyphenate API endpoints requires authentication token for session, unless specified otherwise.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersDeleteAsync(String orgName,
String appName,
String authorization,
String limit,
String cursor,
ApiCallback<String> callback)
Delete Users in Batch (asynchronously)
Delete total number of N user accounts in batch.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersGetAsync(String orgName,
String appName,
String authorization,
String limit,
String cursor,
ApiCallback<String> callback)
Get Users in Batch (asynchronously)
Get a list of users
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersOwnerUsernameBlocksUsersBlockedUsernameDeleteAsync(String orgName,
String appName,
String authorization,
String ownerUsername,
String blockedUsername,
ApiCallback<String> callback)
Unblock User(s) (asynchronously)
Unblock one or multiple users by removing them from blacklist.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersOwnerUsernameBlocksUsersGetAsync(String orgName,
String appName,
String authorization,
String ownerUsername,
ApiCallback<String> callback)
Get a List of Blocked Users (asynchronously)
Get a List of Blocked Users by the user.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersOwnerUsernameBlocksUsersPostAsync(String orgName,
String appName,
String authorization,
String ownerUsername,
UserNames usernames,
ApiCallback<String> callback)
Block User(s) (asynchronously)
Block one or multiple users by adding to blacklist.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersOwnerUsernameContactsUsersFriendUsernameDeleteAsync(String orgName,
String appName,
String authorization,
String ownerUsername,
String friendUsername,
ApiCallback<String> callback)
Remove Contact from User (asynchronously)
Remove contact from user's contact list.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersOwnerUsernameContactsUsersFriendUsernamePostAsync(String orgName,
String appName,
String authorization,
String ownerUsername,
String friendUsername,
ApiCallback<String> callback)
Add Contact for User (asynchronously)
Add contact for user.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersOwnerUsernameContactsUsersGetAsync(String orgName,
String appName,
String authorization,
String ownerUsername,
ApiCallback<String> callback)
Get a List of Contacts (asynchronously)
Get user's contact list
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersOwnerUsernameOfflineMsgCountGetAsync(String orgName,
String appName,
String authorization,
String ownerUsername,
ApiCallback<String> callback)
Get Offline Message Count (asynchronously)
Get the number of offline messages
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersPostAsync(String orgName,
String appName,
RegisterUsers body,
String authorization,
ApiCallback<String> callback)
Create a User (asynchronously)
Register an IM user account respects to org and app keys.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersUsernameActivatePostAsync(String orgName,
String appName,
String authorization,
String username,
ApiCallback<String> callback)
Activate User Account (asynchronously)
Activate a deactivated user account.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersUsernameDeactivatePostAsync(String orgName,
String appName,
String authorization,
String username,
ApiCallback<String> callback)
Deactivate User Account (asynchronously)
Deactivate a user account.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersUsernameDeleteAsync(String orgName,
String appName,
String authorization,
String username,
ApiCallback<String> callback)
Delete a User (asynchronously)
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.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersUsernameDisconnectGetAsync(String orgName,
String appName,
String authorization,
String username,
ApiCallback<String> callback)
Logout User (asynchronously)
Force logout a user
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersUsernameGetAsync(String orgName,
String appName,
String authorization,
String username,
ApiCallback<String> callback)
Get a User (asynchronously)
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersUsernameJoinedChatgroupsGetAsync(String orgName,
String appName,
String authorization,
String username,
ApiCallback<String> callback)
Get a List of Groups of User Joined (asynchronously)
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersUsernameJoinedChatroomsGetAsync(String orgName,
String appName,
String authorization,
String username,
ApiCallback<String> callback)
Get All the Chat Rooms of User Joined (asynchronously)
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersUsernameOfflineMsgStatusMsgIdGetAsync(String orgName,
String appName,
String authorization,
String username,
String msgId,
ApiCallback<String> callback)
Get Offline Message Status (asynchronously)
Get offline message status via message ID.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersUsernamePasswordPutAsync(String orgName,
String appName,
String username,
NewPassword body,
String authorization,
ApiCallback<String> callback)
Reset User's Password (asynchronously)
To enhance security, we recommend update user's Hyphenate IM user account password if the user's app password on developer server is updated.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersUsernamePutAsync(String orgName,
String appName,
String username,
Nickname body,
String authorization,
ApiCallback<String> callback)
Update User's APNs Display Name (asynchronously)
Update user's APNs display name for iOS push notification.
|
com.squareup.okhttp.Call |
UsersApi.orgNameAppNameUsersUsernameStatusGetAsync(String orgName,
String appName,
String authorization,
String username,
ApiCallback<String> callback)
Get User Online Status (asynchronously)
|
Copyright © 2017. All rights reserved.