ChatroomUIKitClient class
- Available extensions
Constructors
Properties
- giftService ↔ GiftService
-
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
-
responses
→ List<
ChatroomEventResponse> -
final
- roomService ↔ ChatRoomService
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- userService ↔ UserService
-
getter/setter pair
Methods
-
bindRoomEventResponse(
ChatroomEventResponse response) → void -
Available on ChatroomUIKitClient, provided by the ControllerResponses extension
bind room event response. -
chatroomOperating(
{required String roomId, required ChatroomOperationType type}) → Future< void> -
Available on ChatroomUIKitClient, provided by the ChatRoomServiceAction extension
chat room operation method. -
fetchMutes(
{required String roomId, int pageSize = 20, int pageNum = 1}) → Future< List< String> > -
Available on ChatroomUIKitClient, provided by the ChatRoomServiceAction extension
fetch chat room mute members. -
fetchParticipants(
{required String roomId, int pageSize = 20, String? cursor}) → Future< CursorResult< String> > -
Available on ChatroomUIKitClient, provided by the ChatRoomServiceAction extension
fetch chat room members. -
fetchUserInfos(
{required List< String> userIds}) → Future<List< UserInfoProtocol> > -
Available on ChatroomUIKitClient, provided by the UserServiceAction extension
fetch user info. -
initWithAppkey(
String appkey, {bool debugMode = false, bool autoLogin = false}) → Future< void> -
loginWithPassword(
{required String userId, required String password, UserInfoProtocol? userInfo}) → Future< void> -
Available on ChatroomUIKitClient, provided by the UserServiceAction extension
login with password. -
loginWithToken(
{required String userId, required String token, UserInfoProtocol? userInfo}) → Future< void> -
Available on ChatroomUIKitClient, provided by the UserServiceAction extension
login with token. -
logout(
) → Future< void> -
Available on ChatroomUIKitClient, provided by the UserServiceAction extension
logout. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
operatingUser(
{required String roomId, required ChatroomUserOperationType type, required String userId}) → Future< void> -
Available on ChatroomUIKitClient, provided by the ChatRoomServiceAction extension
operating chat room user. -
recall(
{required String roomId, required Message message}) → Future< void> -
Available on ChatroomUIKitClient, provided by the ChatRoomServiceAction extension
recall message. default support recall message which is sent in 2 minutes. you can change it by backend. room owner can recall any message. -
refreshToken(
{required String token}) → Future< void> -
Available on ChatroomUIKitClient, provided by the UserServiceAction extension
refresh token, if you use token to login, you need to refresh token when token expired. -
report(
{required String roomId, required String messageId, required String tag, required String reason}) → Future< void> -
Available on ChatroomUIKitClient, provided by the ChatRoomServiceAction extension
report message. -
sendCustomMessage(
{required String roomId, required String event, required Map< String, String> params, List<String> ? receiver}) → Future<void> -
Available on ChatroomUIKitClient, provided by the ChatRoomServiceAction extension
send custom message. -
sendGift(
{required String roomId, required GiftEntityProtocol gift, UserInfoProtocol? user}) → Future< void> -
Available on ChatroomUIKitClient, provided by the GiftServiceAction extension
-
sendRoomMessage(
{required String roomId, required String message, List< String> ? receiver}) → Future<void> -
Available on ChatroomUIKitClient, provided by the ChatRoomServiceAction extension
send room message. -
toString(
) → String -
A string representation of this object.
inherited
-
translateMessage(
{required String roomId, required Message message, required LanguageCode language}) → Future< Message?> -
Available on ChatroomUIKitClient, provided by the ChatRoomServiceAction extension
translate message. -
unbindRoomEventResponse(
ChatroomEventResponse response) → void -
Available on ChatroomUIKitClient, provided by the ControllerResponses extension
unbind room event response. -
unInit(
) → void -
updateUserInfo(
{UserInfoProtocol? user}) → Future< void> -
Available on ChatroomUIKitClient, provided by the UserServiceAction extension
update user info.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance → ChatroomUIKitClient
-
no setter