Skip to main content

createDesiredPropertiesObject

@discordeno/botDocs


Documentation / @discordeno/bot / createDesiredPropertiesObject

Function: createDesiredPropertiesObject()

createDesiredPropertiesObject(desiredProperties, defaultValue): TransformersDesiredProperties

Parameters

desiredProperties

desiredProperties.activityInstance?

desiredProperties.activityInstance.applicationId: undefined | boolean

desiredProperties.activityInstance.instanceId: undefined | boolean

desiredProperties.activityInstance.launchId: undefined | boolean

desiredProperties.activityInstance.location: undefined | boolean

desiredProperties.activityInstance.users: undefined | boolean

desiredProperties.activityLocation?

desiredProperties.activityLocation.channelId: undefined | boolean

desiredProperties.activityLocation.guildId: undefined | boolean

desiredProperties.activityLocation.id: undefined | boolean

desiredProperties.activityLocation.kind: undefined | boolean

desiredProperties.attachment?

desiredProperties.attachment.contentType: undefined | boolean

desiredProperties.attachment.description: undefined | boolean

desiredProperties.attachment.duration_secs: undefined | boolean

desiredProperties.attachment.ephemeral: undefined | boolean

desiredProperties.attachment.filename: undefined | boolean

desiredProperties.attachment.flags: undefined | boolean

desiredProperties.attachment.height: undefined | boolean

desiredProperties.attachment.id: undefined | boolean

desiredProperties.attachment.proxyUrl: undefined | boolean

desiredProperties.attachment.size: undefined | boolean

desiredProperties.attachment.title: undefined | boolean

desiredProperties.attachment.url: undefined | boolean

desiredProperties.attachment.waveform: undefined | boolean

desiredProperties.attachment.width: undefined | boolean

desiredProperties.avatarDecorationData?

desiredProperties.avatarDecorationData.asset: undefined | boolean

desiredProperties.avatarDecorationData.skuId: undefined | boolean

desiredProperties.channel?

desiredProperties.channel.applicationId: undefined | boolean

desiredProperties.channel.appliedTags: undefined | boolean

desiredProperties.channel.availableTags: undefined | boolean

desiredProperties.channel.bitrate: undefined | boolean

desiredProperties.channel.defaultAutoArchiveDuration: undefined | boolean

desiredProperties.channel.defaultForumLayout: undefined | boolean

desiredProperties.channel.defaultReactionEmoji: undefined | boolean

desiredProperties.channel.defaultSortOrder: undefined | boolean

desiredProperties.channel.defaultThreadRateLimitPerUser: undefined | boolean

desiredProperties.channel.flags: undefined | boolean

desiredProperties.channel.guildId: undefined | boolean

desiredProperties.channel.icon: undefined | boolean

desiredProperties.channel.id: undefined | boolean

desiredProperties.channel.lastMessageId: undefined | boolean

desiredProperties.channel.lastPinTimestamp: undefined | boolean

desiredProperties.channel.member: undefined | boolean

desiredProperties.channel.memberCount: undefined | boolean

desiredProperties.channel.messageCount: undefined | boolean

desiredProperties.channel.name: undefined | boolean

desiredProperties.channel.ownerId: undefined | boolean

desiredProperties.channel.parentId: undefined | boolean

desiredProperties.channel.permissionOverwrites: undefined | boolean

desiredProperties.channel.permissions: undefined | boolean

desiredProperties.channel.position: undefined | boolean

desiredProperties.channel.rateLimitPerUser: undefined | boolean

desiredProperties.channel.recipients: undefined | boolean

desiredProperties.channel.rtcRegion: undefined | boolean

desiredProperties.channel.threadMetadata: undefined | boolean

desiredProperties.channel.topic: undefined | boolean

desiredProperties.channel.totalMessageSent: undefined | boolean

desiredProperties.channel.type: undefined | boolean

desiredProperties.channel.userLimit: undefined | boolean

desiredProperties.channel.videoQualityMode: undefined | boolean

desiredProperties.defaultReactionEmoji?

desiredProperties.defaultReactionEmoji.emojiId: undefined | boolean

desiredProperties.defaultReactionEmoji.emojiName: undefined | boolean

desiredProperties.emoji?

desiredProperties.emoji.id: undefined | boolean

desiredProperties.emoji.name: undefined | boolean

desiredProperties.emoji.roles: undefined | boolean

desiredProperties.emoji.user: undefined | boolean

desiredProperties.entitlement?

desiredProperties.entitlement.applicationId: undefined | boolean

desiredProperties.entitlement.consumed: undefined | boolean

desiredProperties.entitlement.deleted: undefined | boolean

desiredProperties.entitlement.endsAt: undefined | boolean

desiredProperties.entitlement.guildId: undefined | boolean

desiredProperties.entitlement.id: undefined | boolean

desiredProperties.entitlement.skuId: undefined | boolean

desiredProperties.entitlement.startsAt: undefined | boolean

desiredProperties.entitlement.type: undefined | boolean

desiredProperties.entitlement.userId: undefined | boolean

desiredProperties.forumTag?

desiredProperties.forumTag.emojiId: undefined | boolean

desiredProperties.forumTag.emojiName: undefined | boolean

desiredProperties.forumTag.id: undefined | boolean

desiredProperties.forumTag.moderated: undefined | boolean

desiredProperties.forumTag.name: undefined | boolean

desiredProperties.guild?

desiredProperties.guild.afkChannelId: undefined | boolean

desiredProperties.guild.afkTimeout: undefined | boolean

desiredProperties.guild.applicationId: undefined | boolean

desiredProperties.guild.approximateMemberCount: undefined | boolean

desiredProperties.guild.approximatePresenceCount: undefined | boolean

desiredProperties.guild.banner: undefined | boolean

desiredProperties.guild.channels: undefined | boolean

desiredProperties.guild.defaultMessageNotifications: undefined | boolean

desiredProperties.guild.description: undefined | boolean

desiredProperties.guild.discoverySplash: undefined | boolean

desiredProperties.guild.emojis: undefined | boolean

desiredProperties.guild.explicitContentFilter: undefined | boolean

desiredProperties.guild.icon: undefined | boolean

desiredProperties.guild.iconHash: undefined | boolean

desiredProperties.guild.id: undefined | boolean

desiredProperties.guild.joinedAt: undefined | boolean

desiredProperties.guild.large: undefined | boolean

desiredProperties.guild.maxMembers: undefined | boolean

desiredProperties.guild.maxPresences: undefined | boolean

desiredProperties.guild.maxStageVideoChannelUsers: undefined | boolean

desiredProperties.guild.maxVideoChannelUsers: undefined | boolean

desiredProperties.guild.memberCount: undefined | boolean

desiredProperties.guild.members: undefined | boolean

desiredProperties.guild.mfaLevel: undefined | boolean

desiredProperties.guild.name: undefined | boolean

desiredProperties.guild.nsfwLevel: undefined | boolean

desiredProperties.guild.owner: undefined | boolean

desiredProperties.guild.ownerId: undefined | boolean

desiredProperties.guild.permissions: undefined | boolean

desiredProperties.guild.preferredLocale: undefined | boolean

desiredProperties.guild.premiumProgressBarEnabled: undefined | boolean

desiredProperties.guild.premiumSubscriptionCount: undefined | boolean

desiredProperties.guild.premiumTier: undefined | boolean

desiredProperties.guild.presences: undefined | boolean

desiredProperties.guild.publicUpdatesChannelId: undefined | boolean

desiredProperties.guild.roles: undefined | boolean

desiredProperties.guild.rulesChannelId: undefined | boolean

desiredProperties.guild.safetyAlertsChannelId: undefined | boolean

desiredProperties.guild.shardId: undefined | boolean

desiredProperties.guild.splash: undefined | boolean

desiredProperties.guild.stageInstances: undefined | boolean

desiredProperties.guild.stickers: undefined | boolean

desiredProperties.guild.systemChannelFlags: undefined | boolean

desiredProperties.guild.systemChannelId: undefined | boolean

desiredProperties.guild.toggles: undefined | boolean

desiredProperties.guild.unavailable: undefined | boolean

desiredProperties.guild.vanityUrlCode: undefined | boolean

desiredProperties.guild.verificationLevel: undefined | boolean

desiredProperties.guild.voiceStates: undefined | boolean

desiredProperties.guild.welcomeScreen: undefined | boolean

desiredProperties.guild.widgetChannelId: undefined | boolean

desiredProperties.guild.widgetEnabled: undefined | boolean

desiredProperties.guildOnboarding?

desiredProperties.guildOnboarding.defaultChannelIds: undefined | boolean

desiredProperties.guildOnboarding.enabled: undefined | boolean

desiredProperties.guildOnboarding.guildId: undefined | boolean

desiredProperties.guildOnboarding.mode: undefined | boolean

desiredProperties.guildOnboarding.prompts: undefined | boolean

desiredProperties.guildOnboardingPrompt?

desiredProperties.guildOnboardingPrompt.id: undefined | boolean

desiredProperties.guildOnboardingPrompt.inOnboarding: undefined | boolean

desiredProperties.guildOnboardingPrompt.options: undefined | boolean

desiredProperties.guildOnboardingPrompt.required: undefined | boolean

desiredProperties.guildOnboardingPrompt.singleSelect: undefined | boolean

desiredProperties.guildOnboardingPrompt.title: undefined | boolean

desiredProperties.guildOnboardingPrompt.type: undefined | boolean

desiredProperties.guildOnboardingPromptOption?

desiredProperties.guildOnboardingPromptOption.channelIds: undefined | boolean

desiredProperties.guildOnboardingPromptOption.description: undefined | boolean

desiredProperties.guildOnboardingPromptOption.emoji: undefined | boolean

desiredProperties.guildOnboardingPromptOption.id: undefined | boolean

desiredProperties.guildOnboardingPromptOption.roleIds: undefined | boolean

desiredProperties.guildOnboardingPromptOption.title: undefined | boolean

desiredProperties.interaction?

desiredProperties.interaction.applicationId: undefined | boolean

desiredProperties.interaction.appPermissions: undefined | boolean

desiredProperties.interaction.authorizingIntegrationOwners: undefined | boolean

desiredProperties.interaction.channel: undefined | boolean

desiredProperties.interaction.channelId: undefined | boolean

desiredProperties.interaction.context: undefined | boolean

desiredProperties.interaction.data: undefined | boolean

desiredProperties.interaction.guild: undefined | boolean

desiredProperties.interaction.guildId: undefined | boolean

desiredProperties.interaction.guildLocale: undefined | boolean

desiredProperties.interaction.id: undefined | boolean

desiredProperties.interaction.locale: undefined | boolean

desiredProperties.interaction.member: undefined | boolean

desiredProperties.interaction.message: undefined | boolean

desiredProperties.interaction.token: undefined | boolean

desiredProperties.interaction.type: undefined | boolean

desiredProperties.interaction.user: undefined | boolean

desiredProperties.interaction.version: undefined | boolean

desiredProperties.interactionCallback?

desiredProperties.interactionCallback.activityInstanceId: undefined | boolean

desiredProperties.interactionCallback.id: undefined | boolean

desiredProperties.interactionCallback.responseMessageEphemeral: undefined | boolean

desiredProperties.interactionCallback.responseMessageId: undefined | boolean

desiredProperties.interactionCallback.responseMessageLoading: undefined | boolean

desiredProperties.interactionCallback.type: undefined | boolean

desiredProperties.interactionCallbackResponse?

desiredProperties.interactionCallbackResponse.interaction: undefined | boolean

desiredProperties.interactionCallbackResponse.resource: undefined | boolean

desiredProperties.interactionResource?

desiredProperties.interactionResource.activityInstance: undefined | boolean

desiredProperties.interactionResource.message: undefined | boolean

desiredProperties.interactionResource.type: undefined | boolean

desiredProperties.invite?

desiredProperties.invite.approximateMemberCount: undefined | boolean

desiredProperties.invite.approximatePresenceCount: undefined | boolean

desiredProperties.invite.channelId: undefined | boolean

desiredProperties.invite.code: undefined | boolean

desiredProperties.invite.createdAt: undefined | boolean

desiredProperties.invite.expiresAt: undefined | boolean

desiredProperties.invite.guildId: undefined | boolean

desiredProperties.invite.guildScheduledEvent: undefined | boolean

desiredProperties.invite.inviter: undefined | boolean

desiredProperties.invite.maxAge: undefined | boolean

desiredProperties.invite.maxUses: undefined | boolean

desiredProperties.invite.stageInstance: undefined | boolean

desiredProperties.invite.targetApplication: undefined | boolean

desiredProperties.invite.targetType: undefined | boolean

desiredProperties.invite.targetUser: undefined | boolean

desiredProperties.invite.temporary: undefined | boolean

desiredProperties.invite.type: undefined | boolean

desiredProperties.invite.uses: undefined | boolean

desiredProperties.inviteStageInstance?

desiredProperties.inviteStageInstance.members: undefined | boolean

desiredProperties.inviteStageInstance.participantCount: undefined | boolean

desiredProperties.inviteStageInstance.speakerCount: undefined | boolean

desiredProperties.inviteStageInstance.topic: undefined | boolean

desiredProperties.member?

desiredProperties.member.avatar: undefined | boolean

desiredProperties.member.avatarDecorationData: undefined | boolean

desiredProperties.member.banner: undefined | boolean

desiredProperties.member.communicationDisabledUntil: undefined | boolean

desiredProperties.member.guildId: undefined | boolean

desiredProperties.member.id: undefined | boolean

desiredProperties.member.joinedAt: undefined | boolean

desiredProperties.member.nick: undefined | boolean

desiredProperties.member.permissions: undefined | boolean

desiredProperties.member.premiumSince: undefined | boolean

desiredProperties.member.roles: undefined | boolean

desiredProperties.member.toggles: undefined | boolean

desiredProperties.member.user: undefined | boolean

desiredProperties.message?

desiredProperties.message.activity: undefined | boolean

desiredProperties.message.application: undefined | boolean

desiredProperties.message.applicationId: undefined | boolean

desiredProperties.message.attachments: undefined | boolean

desiredProperties.message.author: undefined | boolean

desiredProperties.message.call: undefined | boolean

desiredProperties.message.channelId: undefined | boolean

desiredProperties.message.components: undefined | boolean

desiredProperties.message.content: undefined | boolean

desiredProperties.message.editedTimestamp: undefined | boolean

desiredProperties.message.embeds: undefined | boolean

desiredProperties.message.guildId: undefined | boolean

desiredProperties.message.id: undefined | boolean

desiredProperties.message.interaction: undefined | boolean

desiredProperties.message.interactionMetadata: undefined | boolean

desiredProperties.message.member: undefined | boolean

desiredProperties.message.mentionedChannelIds: undefined | boolean

desiredProperties.message.mentionedRoleIds: undefined | boolean

desiredProperties.message.mentions: undefined | boolean

desiredProperties.message.messageReference: undefined | boolean

desiredProperties.message.messageSnapshots: undefined | boolean

desiredProperties.message.nonce: undefined | boolean

desiredProperties.message.poll: undefined | boolean

desiredProperties.message.reactions: undefined | boolean

desiredProperties.message.referencedMessage: undefined | boolean

desiredProperties.message.stickerItems: undefined | boolean

desiredProperties.message.thread: undefined | boolean

desiredProperties.message.type: undefined | boolean

desiredProperties.message.webhookId: undefined | boolean

desiredProperties.messageCall?

desiredProperties.messageCall.endedTimestamp: undefined | boolean

desiredProperties.messageCall.participants: undefined | boolean

desiredProperties.messageInteraction?

desiredProperties.messageInteraction.id: undefined | boolean

desiredProperties.messageInteraction.member: undefined | boolean

desiredProperties.messageInteraction.name: undefined | boolean

desiredProperties.messageInteraction.type: undefined | boolean

desiredProperties.messageInteraction.user: undefined | boolean

desiredProperties.messageInteractionMetadata?

desiredProperties.messageInteractionMetadata.authorizingIntegrationOwners: undefined | boolean

desiredProperties.messageInteractionMetadata.id: undefined | boolean

desiredProperties.messageInteractionMetadata.interactedMessageId: undefined | boolean

desiredProperties.messageInteractionMetadata.originalResponseMessageId: undefined | boolean

desiredProperties.messageInteractionMetadata.targetMessageId: undefined | boolean

desiredProperties.messageInteractionMetadata.targetUser: undefined | boolean

desiredProperties.messageInteractionMetadata.triggeringInteractionMetadata: undefined | boolean

desiredProperties.messageInteractionMetadata.type: undefined | boolean

desiredProperties.messageInteractionMetadata.user: undefined | boolean

desiredProperties.messageReference?

desiredProperties.messageReference.channelId: undefined | boolean

desiredProperties.messageReference.guildId: undefined | boolean

desiredProperties.messageReference.messageId: undefined | boolean

desiredProperties.messageSnapshot?

desiredProperties.messageSnapshot.message: undefined | boolean

desiredProperties.poll?

desiredProperties.poll.allowMultiselect: undefined | boolean

desiredProperties.poll.answers: undefined | boolean

desiredProperties.poll.expiry: undefined | boolean

desiredProperties.poll.layoutType: undefined | boolean

desiredProperties.poll.question: undefined | boolean

desiredProperties.poll.results: undefined | boolean

desiredProperties.pollAnswer?

desiredProperties.pollAnswer.answerId: undefined | boolean

desiredProperties.pollAnswer.pollMedia: undefined | boolean

desiredProperties.pollAnswerCount?

desiredProperties.pollAnswerCount.count: undefined | boolean

desiredProperties.pollAnswerCount.id: undefined | boolean

desiredProperties.pollAnswerCount.meVoted: undefined | boolean

desiredProperties.pollMedia?

desiredProperties.pollMedia.emoji: undefined | boolean

desiredProperties.pollMedia.text: undefined | boolean

desiredProperties.pollResult?

desiredProperties.pollResult.answerCounts: undefined | boolean

desiredProperties.pollResult.isFinalized: undefined | boolean

desiredProperties.role?

desiredProperties.role.color: undefined | boolean

desiredProperties.role.flags: undefined | boolean

desiredProperties.role.guildId: undefined | boolean

desiredProperties.role.icon: undefined | boolean

desiredProperties.role.id: undefined | boolean

desiredProperties.role.name: undefined | boolean

desiredProperties.role.permissions: undefined | boolean

desiredProperties.role.position: undefined | boolean

desiredProperties.role.tags: undefined | boolean

desiredProperties.role.toggles: undefined | boolean

desiredProperties.role.unicodeEmoji: undefined | boolean

desiredProperties.scheduledEvent?

desiredProperties.scheduledEvent.channelId: undefined | boolean

desiredProperties.scheduledEvent.creator: undefined | boolean

desiredProperties.scheduledEvent.creatorId: undefined | boolean

desiredProperties.scheduledEvent.description: undefined | boolean

desiredProperties.scheduledEvent.entityId: undefined | boolean

desiredProperties.scheduledEvent.entityType: undefined | boolean

desiredProperties.scheduledEvent.guildId: undefined | boolean

desiredProperties.scheduledEvent.id: undefined | boolean

desiredProperties.scheduledEvent.image: undefined | boolean

desiredProperties.scheduledEvent.location: undefined | boolean

desiredProperties.scheduledEvent.name: undefined | boolean

desiredProperties.scheduledEvent.privacyLevel: undefined | boolean

desiredProperties.scheduledEvent.recurrenceRule: undefined | boolean

desiredProperties.scheduledEvent.scheduledEndTime: undefined | boolean

desiredProperties.scheduledEvent.scheduledStartTime: undefined | boolean

desiredProperties.scheduledEvent.status: undefined | boolean

desiredProperties.scheduledEvent.userCount: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule?

desiredProperties.scheduledEventRecurrenceRule.byMonth: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.byMonthDay: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.byNWeekday: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.byWeekday: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.byYearDay: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.count: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.end: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.frequency: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.interval: undefined | boolean

desiredProperties.scheduledEventRecurrenceRule.start: undefined | boolean

desiredProperties.sku?

desiredProperties.sku.applicationId: undefined | boolean

desiredProperties.sku.flags: undefined | boolean

desiredProperties.sku.id: undefined | boolean

desiredProperties.sku.name: undefined | boolean

desiredProperties.sku.slug: undefined | boolean

desiredProperties.sku.type: undefined | boolean

desiredProperties.soundboardSound?

desiredProperties.soundboardSound.available: undefined | boolean

desiredProperties.soundboardSound.emojiId: undefined | boolean

desiredProperties.soundboardSound.emojiName: undefined | boolean

desiredProperties.soundboardSound.guildId: undefined | boolean

desiredProperties.soundboardSound.name: undefined | boolean

desiredProperties.soundboardSound.soundId: undefined | boolean

desiredProperties.soundboardSound.user: undefined | boolean

desiredProperties.soundboardSound.volume: undefined | boolean

desiredProperties.stageInstance?

desiredProperties.stageInstance.channelId: undefined | boolean

desiredProperties.stageInstance.guildId: undefined | boolean

desiredProperties.stageInstance.guildScheduledEventId: undefined | boolean

desiredProperties.stageInstance.id: undefined | boolean

desiredProperties.stageInstance.topic: undefined | boolean

desiredProperties.sticker?

desiredProperties.sticker.available: undefined | boolean

desiredProperties.sticker.description: undefined | boolean

desiredProperties.sticker.formatType: undefined | boolean

desiredProperties.sticker.guildId: undefined | boolean

desiredProperties.sticker.id: undefined | boolean

desiredProperties.sticker.name: undefined | boolean

desiredProperties.sticker.packId: undefined | boolean

desiredProperties.sticker.sortValue: undefined | boolean

desiredProperties.sticker.tags: undefined | boolean

desiredProperties.sticker.type: undefined | boolean

desiredProperties.sticker.user: undefined | boolean

desiredProperties.subscription?

desiredProperties.subscription.canceledAt: undefined | boolean

desiredProperties.subscription.country: undefined | boolean

desiredProperties.subscription.currentPeriodEnd: undefined | boolean

desiredProperties.subscription.currentPeriodStart: undefined | boolean

desiredProperties.subscription.entitlementIds: undefined | boolean

desiredProperties.subscription.id: undefined | boolean

desiredProperties.subscription.skuIds: undefined | boolean

desiredProperties.subscription.status: undefined | boolean

desiredProperties.subscription.userId: undefined | boolean

desiredProperties.user?

desiredProperties.user.accentColor: undefined | boolean

desiredProperties.user.avatar: undefined | boolean

desiredProperties.user.avatarDecorationData: undefined | boolean

desiredProperties.user.banner: undefined | boolean

desiredProperties.user.discriminator: undefined | boolean

desiredProperties.user.email: undefined | boolean

desiredProperties.user.flags: undefined | boolean

desiredProperties.user.globalName: undefined | boolean

desiredProperties.user.id: undefined | boolean

desiredProperties.user.locale: undefined | boolean

desiredProperties.user.premiumType: undefined | boolean

desiredProperties.user.publicFlags: undefined | boolean

desiredProperties.user.toggles: undefined | boolean

desiredProperties.user.username: undefined | boolean

desiredProperties.voiceState?

desiredProperties.voiceState.channelId: undefined | boolean

desiredProperties.voiceState.guildId: undefined | boolean

desiredProperties.voiceState.requestToSpeakTimestamp: undefined | boolean

desiredProperties.voiceState.sessionId: undefined | boolean

desiredProperties.voiceState.toggles: undefined | boolean

desiredProperties.voiceState.userId: undefined | boolean

desiredProperties.webhook?

desiredProperties.webhook.applicationId: undefined | boolean

desiredProperties.webhook.avatar: undefined | boolean

desiredProperties.webhook.channelId: undefined | boolean

desiredProperties.webhook.guildId: undefined | boolean

desiredProperties.webhook.id: undefined | boolean

desiredProperties.webhook.name: undefined | boolean

desiredProperties.webhook.sourceChannel: undefined | boolean

desiredProperties.webhook.sourceGuild: undefined | boolean

desiredProperties.webhook.token: undefined | boolean

desiredProperties.webhook.type: undefined | boolean

desiredProperties.webhook.url: undefined | boolean

desiredProperties.webhook.user: undefined | boolean

defaultValue: boolean = false

Returns

TransformersDesiredProperties

Defined in

packages/bot/src/desiredProperties.ts:204