Interface ModerationApi
-
- All Implemented Interfaces:
public interface ModerationApi
-
-
Method Summary
Modifier and Type Method Description abstract BlockUserResponseblockUser(@Path(value = "type") String type, @Path(value = "id") String id, @Body() BlockUserRequest blockUserRequest)Block user on a call Block a user, preventing them from joining the call until they are unblocked. abstract MuteUsersResponsemuteUsers(@Path(value = "type") String type, @Path(value = "id") String id, @Body() MuteUsersRequest muteUsersRequest)Mute users Mutes users in a call Required permissions: - MuteUsers Responses: 201: Successful response
400: Bad request
429: Too many requests
abstract RequestPermissionResponserequestPermission(@Path(value = "type") String type, @Path(value = "id") String id, @Body() RequestPermissionRequest requestPermissionRequest)Request permission Request permission to perform an action Sends events: - call. abstract UnblockUserResponseunblockUser(@Path(value = "type") String type, @Path(value = "id") String id, @Body() UnblockUserRequest unblockUserRequest)Unblocks user on a call Removes the block for a user on a call. abstract UpdateUserPermissionsResponseupdateUserPermissions(@Path(value = "type") String type, @Path(value = "id") String id, @Body() UpdateUserPermissionsRequest updateUserPermissionsRequest)Update user permissions Updates user permissions Sends events: - call. -
-
Method Detail
-
blockUser
@POST(value = "/video/call/{type}/{id}/block") abstract BlockUserResponse blockUser(@Path(value = "type") String type, @Path(value = "id") String id, @Body() BlockUserRequest blockUserRequest)Block user on a call Block a user, preventing them from joining the call until they are unblocked. Sends events: - call.blocked_user Required permissions: - BlockUser Responses:
201: Successful response
400: Bad request
429: Too many requests
-
muteUsers
@POST(value = "/video/call/{type}/{id}/mute_users") abstract MuteUsersResponse muteUsers(@Path(value = "type") String type, @Path(value = "id") String id, @Body() MuteUsersRequest muteUsersRequest)Mute users Mutes users in a call Required permissions: - MuteUsers Responses:
201: Successful response
400: Bad request
429: Too many requests
-
requestPermission
@POST(value = "/video/call/{type}/{id}/request_permission") abstract RequestPermissionResponse requestPermission(@Path(value = "type") String type, @Path(value = "id") String id, @Body() RequestPermissionRequest requestPermissionRequest)Request permission Request permission to perform an action Sends events: - call.permission_request Responses:
201: Successful response
400: Bad request
429: Too many requests
-
unblockUser
@POST(value = "/video/call/{type}/{id}/unblock") abstract UnblockUserResponse unblockUser(@Path(value = "type") String type, @Path(value = "id") String id, @Body() UnblockUserRequest unblockUserRequest)Unblocks user on a call Removes the block for a user on a call. The user will be able to join the call again. Sends events: - call.unblocked_user Required permissions: - BlockUser Responses:
201: Successful response
400: Bad request
429: Too many requests
-
updateUserPermissions
@POST(value = "/video/call/{type}/{id}/user_permissions") abstract UpdateUserPermissionsResponse updateUserPermissions(@Path(value = "type") String type, @Path(value = "id") String id, @Body() UpdateUserPermissionsRequest updateUserPermissionsRequest)Update user permissions Updates user permissions Sends events: - call.permissions_updated Required permissions: - UpdateCallPermissions Responses:
201: Successful response
400: Bad request
429: Too many requests
-
-
-