UsersApi class abstract

Annotations
  • @RestApi.new()

Constructors

UsersApi(Dio dio, {String? baseUrl})
factory

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

acceptOrUpdateFriendRequest({required SnowflakeType userId, required RelationshipTypePutRequest body}) Future<RelationshipResponse>
Accept or update friend request.
acceptUpdatedTerms({required EmptyBodyRequest body}) Future<UserPrivateResponse>
Accept updated terms of service and privacy policy.
applyEmailChange({required EmailChangeApplyRequest body}) Future<UserPrivateResponse>
Apply a verified email change.
bulkDeleteMyMessages({required BulkDeleteSelfMessagesRequest body}) Future<void>
Delete my messages with optional filters.
bulkIgnoreFriendRequests({required BulkIgnoreFriendRequestsRequest body}) Future<BulkIgnoreFriendRequestsResponse>
Bulk ignore friend requests.
cancelBulkMessageDeletion2() Future<SuccessResponse>
Cancel bulk message deletion.
cancelScheduledMessage({required String scheduledMessageId}) Future<void>
Cancel scheduled message.
checkUsernameTagAvailability({required UsernameType username, required String discriminator}) Future<UserTagCheckResponse>
Check username tag availability.
completePasswordChange({required PasswordChangeCompleteRequest body}) Future<PasswordChangeCompleteResponse>
Complete password change.
createPrivateChannel({required CreatePrivateChannelRequest body}) Future<ChannelResponse>
Create private channel.
deleteCurrentUserAccount({required SudoVerificationSchema body}) Future<void>
Delete current user account.
deleteMention({required SnowflakeType messageId}) Future<void>
Delete mention.
deleteMobilePushDevice({required String deviceId}) Future<SuccessResponse>
Delete mobile push device.
deleteWebauthnCredential({required String credentialId, required SudoVerificationSchema body}) Future<void>
Delete WebAuthn credential.
disableCurrentUserAccount({required SudoVerificationSchema body}) Future<void>
Disable current user account.
disableTotpMfa({required DisableTotpRequest body}) Future<void>
Disable TOTP multi-factor authentication.
enableTotpMfa({required EnableMfaTotpRequest body}) Future<MfaBackupCodesResponse>
Enable TOTP multi-factor authentication.
forgetAuthorizedIps({required SudoVerificationSchema body}) Future<void>
Forget authorized IPs for current user.
getBackupCodesMfa({required MfaBackupCodesRequest body}) Future<MfaBackupCodesResponse>
Get backup codes for multi-factor authentication.
getCurrentUser() Future<UserPrivateResponse>
Get current user profile.
getCurrentUserSettings() Future<UserSettingsResponse>
Get current user settings.
getDataHarvestDownloadUrl({required String harvestId}) Future<HarvestDownloadUrlResponse>
Get data harvest download URL.
getDataHarvestStatus({required String harvestId}) Future<HarvestStatusResponseSchema>
Get data harvest status.
getLatestDataHarvest() Future<HarvestStatusResponseSchemaNullable>
Get latest data harvest.
getNoteOnUser({required String targetId}) Future<UserNoteResponse>
Get note on user.
getScheduledMessage({required String scheduledMessageId}) Future<ScheduledMessageResponseSchema>
Get scheduled message.
getSudoWebauthnAuthenticationOptions() Future<WebAuthnChallengeResponse>
Get sudo WebAuthn authentication options.
getUserById({required SnowflakeType userId}) Future<UserPartialResponse>
Get user by ID.
getUserProfile({required String targetId, SnowflakeType? guildId, String? withMutualFriends, String? withMutualGuilds}) Future<UserProfileFullResponse>
Get user profile.
getWebauthnRegistrationOptions({required SudoVerificationSchema body}) Future<WebAuthnChallengeResponse>
Get WebAuthn registration options.
joinCanaryTesters() Future<SuccessResponse>
Join the canary testers guild.
listCurrentUserNotes() Future<UserNotesRecordResponse>
List current user notes.
listMentionsForCurrentUser({String? limit, String? roles, String? everyone, String? guilds, SnowflakeType? before}) Future<MessageListResponse>
List mentions for current user.
listMobilePushDevices() Future<MobileDevicesListResponse>
List mobile push devices.
listPrivateChannels() Future<List<ChannelResponse>>
List private channels.
listPushSubscriptions() Future<PushSubscriptionsListResponse>
List push subscriptions.
listSavedMessages({String? limit}) Future<SavedMessageEntryListResponse>
List saved messages.
listScheduledMessages() Future<List<ScheduledMessageResponseSchema>>
List scheduled messages.
listSudoMfaMethods() Future<SudoMfaMethodsResponse>
List sudo multi-factor authentication methods.
listUserGifts() Future<List<GiftCodeMetadataResponse>>
List user gifts.
listUserRelationships2() Future<List<RelationshipResponse>>
List user relationships.
listWebauthnCredentials() Future<WebAuthnCredentialListResponse>
List WebAuthn credentials.
markMentionsRead({required MarkMentionsReadRequest body}) Future<void>
Mark mentions read.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pinDirectMessageChannel({required SnowflakeType channelId}) Future<void>
Pin direct message channel.
preloadMessagesForChannels({required PreloadMessagesRequest body}) Future<PreloadMessagesResponse>
Preload messages for channels.
preloadMessagesForChannelsAlt({required PreloadMessagesRequest body}) Future<PreloadMessagesResponse>
Preload messages for channels (alternative).
registerMobilePushDevice({required RegisterMobileDeviceRequest body}) Future<RegisterMobileDeviceResponse>
Register mobile push device.
registerWebauthnCredential({required WebAuthnRegisterRequest body}) Future<void>
Register WebAuthn credential.
removeRelationship({required SnowflakeType userId}) Future<void>
Remove relationship.
requestBouncedEmailReplacement({required EmailChangeBouncedRequestNewRequest body}) Future<EmailChangeRequestNewResponse>
Request replacement email for bounced address.
requestBulkMessageDeletion({required SudoVerificationSchema body}) Future<void>
Request bulk message deletion.
requestDataHarvest() Future<HarvestCreationResponseSchema>
Request data harvest.
requestFilteredDataHarvest({required HarvestSelfDataRequest body}) Future<HarvestCreationResponseSchema>
Request filtered data harvest.
requestNewEmailAddress({required EmailChangeRequestNewRequest body}) Future<EmailChangeRequestNewResponse>
Request new email address.
resendBouncedEmailReplacementCode({required EmailChangeTicketRequest body}) Future<void>
Resend replacement email code.
resendNewEmailConfirmation({required EmailChangeTicketRequest body}) Future<void>
Resend new email confirmation.
resendOriginalEmailConfirmation({required EmailChangeTicketRequest body}) Future<void>
Resend original email confirmation.
resendPasswordChangeCode({required PasswordChangeTicketRequest body}) Future<void>
Resend password change verification code.
resetCurrentUserPremiumState() Future<void>
Reset current user premium state.
rotatePushSubscription({required PushRotateRequest body}) Future<PushSubscribeResponse>
Rotate a push notification subscription.
saveMessage({required SaveMessageRequest body}) Future<void>
Save message.
sendFriendRequest({required SnowflakeType userId, required FriendRequestCreateRequest body}) Future<RelationshipResponse>
Send friend request.
sendFriendRequestByTag({required FriendRequestByTagRequest body}) Future<RelationshipResponse>
Send friend request by tag.
sendPhoneVerificationCode({required PhoneSendVerificationRequest body}) Future<PhoneSendVerificationResponse>
Send phone verification code.
setNoteOnUser({required String targetId, required UserNoteUpdateRequest body}) Future<void>
Set note on user.
startEmailChange({required EmptyBodyRequest body}) Future<EmailChangeStartResponse>
Start email change.
startInboundPhoneChallenge() Future<InboundSmsChallengeStartResponse>
Start an inbound SMS challenge.
startPasswordChange({required EmptyBodyRequest body}) Future<PasswordChangeStartResponse>
Start password change.
subscribeToPushNotifications({required PushSubscribeRequest body}) Future<PushSubscribeResponse>
Subscribe to push notifications.
toString() String
A string representation of this object.
inherited
unpinDirectMessageChannel({required SnowflakeType channelId}) Future<void>
Unpin direct message channel.
unregisterMobilePushDevice({required UnregisterMobileDeviceRequest body}) Future<SuccessResponse>
Unregister mobile push device.
unsaveMessage({required SnowflakeType messageId}) Future<void>
Unsave message.
unsubscribeFromPushNotifications({required String subscriptionId}) Future<SuccessResponse>
Unsubscribe from push notifications.
updateCurrentUser({required UserUpdateWithVerificationRequest body}) Future<UserPrivateResponse>
Update current user profile.
updateCurrentUserSettings({required UserSettingsUpdateRequest body}) Future<UserSettingsResponse>
Update current user settings.
updateDmNotificationSettings({required UserGuildSettingsUpdateRequest body}) Future<UserGuildSettingsResponse>
Update DM notification settings.
updateGuildSettingsForUser({required SnowflakeType guildId, required UserGuildSettingsUpdateRequest body}) Future<UserGuildSettingsResponse>
Update guild settings for user.
updateRelationshipNickname({required SnowflakeType userId, required RelationshipNicknameUpdateRequest body}) Future<RelationshipResponse>
Update relationship nickname.
updateScheduledMessage({required String scheduledMessageId, required String scheduledLocalAt, required String timezone, MessageContentRequest? content, List<RichEmbedRequest>? embeds, List<Object3>? attachments, MessageReferenceRequest? messageReference, AllowedMentionsRequest? allowedMentions, MessageFlags? flags, MessageNonceRequest? nonce, SnowflakeType? favoriteMemeId, List<SnowflakeType>? stickerIds, bool? tts}) Future<ScheduledMessageResponseSchema>
Update scheduled message.
updateWebauthnCredential({required String credentialId, required WebAuthnCredentialUpdateRequest body}) Future<void>
Update WebAuthn credential.
verifyBouncedEmailReplacement({required EmailChangeBouncedVerifyNewRequest body}) Future<UserPrivateResponse>
Verify replacement email for bounced address.
verifyNewEmailAddress({required EmailChangeVerifyNewRequest body}) Future<EmailTokenResponse>
Verify new email address.
verifyOriginalEmailAddress({required EmailChangeVerifyOriginalRequest body}) Future<EmailChangeVerifyOriginalResponse>
Verify original email address.
verifyPasswordChangeCode({required PasswordChangeVerifyRequest body}) Future<PasswordChangeVerifyResponse>
Verify password change code.
verifyPhoneCode({required PhoneVerifyRequest body}) Future<PhoneVerifyResponse>
Verify phone code.

Operators

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