BotsApi class

Constructors

BotsApi(Dio _dio, Serializers _serializers)
const

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

assignBot({required String botUserId, required String userId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Bot>>
Assign a bot to a user Assign a bot to a specified user. ##### Permissions Must have `manage_bots` permission. Minimum server version: 5.10
convertBotToUser({required String botUserId, required InlineObject107 inlineObject107, bool? setSystemAdmin = false, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Convert a bot into a user Convert a bot into a user. Minimum server version: 5.26 ##### Permissions Must have `manage_system` permission.
convertUserToBot({required String userId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Convert a user into a bot Convert a user into a bot. Minimum server version: 5.26 ##### Permissions Must have `manage_system` permission.
createBot({required InlineObject104 inlineObject104, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Bot>>
Create a bot Create a new bot account on the system. Username is required. ##### Permissions Must have `create_bot` permission. Minimum server version: 5.10
deleteBotIconImage({required String botUserId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Delete bot's LHS icon image Delete bot's LHS icon image based on bot_user_id string parameter. ##### Permissions Must have `manage_bots` permission. Minimum server version: 5.14
disableBot({required String botUserId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Bot>>
Disable a bot Disable a bot. ##### Permissions Must have `manage_bots` permission. Minimum server version: 5.10
enableBot({required String botUserId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Bot>>
Enable a bot Enable a bot. ##### Permissions Must have `manage_bots` permission. Minimum server version: 5.10
getBot({required String botUserId, bool? includeDeleted, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Bot>>
Get a bot Get a bot specified by its bot id. ##### Permissions Must have `read_bots` permission for bots you are managing, and `read_others_bots` permission for bots others are managing. Minimum server version: 5.10
getBotIconImage({required String botUserId, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<void>>
Get bot's LHS icon Get a bot's LHS icon image based on bot_user_id string parameter. ##### Permissions Must be logged in. Minimum server version: 5.14
getBots({int? page = 0, int? perPage = 60, bool? includeDeleted, bool? onlyOrphaned, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<BuiltList<Bot>>>
Get bots Get a page of a list of bots. ##### Permissions Must have `read_bots` permission for bots you are managing, and `read_others_bots` permission for bots others are managing. Minimum server version: 5.10
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patchBot({required String botUserId, required InlineObject105 inlineObject105, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<Bot>>
Patch a bot Partially update a bot by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions Must have `manage_bots` permission. Minimum server version: 5.10
setBotIconImage({required String botUserId, required MultipartFile image, CancelToken? cancelToken, Map<String, dynamic>? headers, Map<String, dynamic>? extra, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<StatusOK>>
Set bot's LHS icon image Set a bot's LHS icon image based on bot_user_id string parameter. Icon image must be SVG format, all other formats are rejected. ##### Permissions Must have `manage_bots` permission. Minimum server version: 5.14
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited