Guild | yuuko

Hierarchy

Base
- Guild

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Guild(data: BaseData, client: Client): Guild

Inherited from Base.constructor
- Defined in node_modules/eris/index.d.ts:1965
Parameters
- data: BaseData
- client: Client
Returns Guild

Properties

afkChannelID

afkChannelID: null | string

afkTimeout

afkTimeout: number

applicationID

applicationID: null | string

Optional approximateMemberCount

approximateMemberCount: undefined | number

Optional approximatePresenceCount

approximatePresenceCount: undefined | number

Optional autoRemoved

autoRemoved: undefined | boolean

banner

banner: null | string

bannerURL

bannerURL: null | string

channels

channels: Collection<AnyGuildChannel>

createdAt

createdAt: number

defaultNotifications

defaultNotifications: DefaultNotifications

description

description: null | string

discoverySplash

discoverySplash: null | string

discoverySplashURL

discoverySplashURL: null | string

Optional emojiCount

emojiCount: undefined | number

emojis

emojis: Emoji[]

explicitContentFilter

explicitContentFilter: ExplicitContentFilter

features

features: string[]

icon

icon: null | string

iconURL

iconURL: null | string

id

id: string

joinedAt

joinedAt: number

large

large: boolean

maxMembers

maxMembers: number

maxPresences

maxPresences: number

Optional maxVideoChannelUsers

maxVideoChannelUsers: undefined | number

memberCount

memberCount: number

members

members: Collection<Member>

mfaLevel

mfaLevel: DefaultNotifications

name

name: string

nsfw

nsfw: boolean

ownerID

ownerID: string

preferredLocale

preferredLocale: string

Optional premiumSubscriptionCount

premiumSubscriptionCount: undefined | number

premiumTier

premiumTier: PremiumTier

Optional primaryCategory

primaryCategory: undefined | DiscoveryCategory

Optional primaryCategoryID

primaryCategoryID: undefined | number

publicUpdatesChannelID

publicUpdatesChannelID: string

region

region: string

roles

roles: Collection<Role>

rulesChannelID

rulesChannelID: null | string

shard

shard: Shard

splash

splash: null | string

splashURL

splashURL: null | string

systemChannelFlags

systemChannelFlags: number

systemChannelID

systemChannelID: null | string

unavailable

unavailable: boolean

vanityURL

vanityURL: null | string

verificationLevel

verificationLevel: VerificationLevel

voiceStates

voiceStates: Collection<VoiceState>

Optional welcomeScreen

welcomeScreen: undefined | WelcomeScreen

Optional widgetChannelID

widgetChannelID: undefined | null | string

Optional widgetEnabled

widgetEnabled: undefined | null | boolean

Methods

addDiscoverySubcategory

addDiscoverySubcategory(categoryID: string, reason?: string): Promise<DiscoverySubcategoryResponse>

- Defined in node_modules/eris/index.d.ts:1967
Parameters
- categoryID: string
- Optional reason: string
Returns Promise<DiscoverySubcategoryResponse>

addMemberRole

addMemberRole(memberID: string, roleID: string, reason?: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:1968
Parameters
- memberID: string
- roleID: string
- Optional reason: string
Returns Promise<void>

banMember

banMember(userID: string, deleteMessageDays?: number, reason?: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:1969
Parameters
- userID: string
- Optional deleteMessageDays: number
- Optional reason: string
Returns Promise<void>

createChannel

createChannel(name: string): Promise<TextChannel>
createChannel(name: string, type: 0, options?: CreateChannelOptions): Promise<TextChannel>
createChannel(name: string, type: 2, options?: CreateChannelOptions): Promise<VoiceChannel>
createChannel(name: string, type: 4, options?: CreateChannelOptions): Promise<CategoryChannel>
createChannel(name: string, type: 5, options?: string | CreateChannelOptions): Promise<NewsChannel>
createChannel(name: string, type: 6, options?: string | CreateChannelOptions): Promise<StoreChannel>
createChannel(name: string, type: 13, options?: string | CreateChannelOptions): Promise<StageChannel>
createChannel(name: string, type?: number, options?: CreateChannelOptions): Promise<unknown>
createChannel(name: string, type: 0, reason?: string, options?: string | CreateChannelOptions): Promise<TextChannel>
createChannel(name: string, type: 2, reason?: string, options?: string | CreateChannelOptions): Promise<VoiceChannel>
createChannel(name: string, type: 4, reason?: string, options?: string | CreateChannelOptions): Promise<CategoryChannel>
createChannel(name: string, type: 5, reason?: string, options?: string | CreateChannelOptions): Promise<NewsChannel>
createChannel(name: string, type: 6, reason?: string, options?: string | CreateChannelOptions): Promise<StoreChannel>
createChannel(name: string, type: 13, reason?: string, options?: string | CreateChannelOptions): Promise<StageChannel>
createChannel(name: string, type?: number, reason?: string, options?: string | CreateChannelOptions): Promise<unknown>

- Defined in node_modules/eris/index.d.ts:1970
Parameters
- name: string
Returns Promise<TextChannel>
- Defined in node_modules/eris/index.d.ts:1971
Parameters
- name: string
- type: 0
- Optional options: CreateChannelOptions
Returns Promise<TextChannel>
- Defined in node_modules/eris/index.d.ts:1972
Parameters
- name: string
- type: 2
- Optional options: CreateChannelOptions
Returns Promise<VoiceChannel>
- Defined in node_modules/eris/index.d.ts:1973
Parameters
- name: string
- type: 4
- Optional options: CreateChannelOptions
Returns Promise<CategoryChannel>
- Defined in node_modules/eris/index.d.ts:1974
Parameters
- name: string
- type: 5
- Optional options: string | CreateChannelOptions
Returns Promise<NewsChannel>
- Defined in node_modules/eris/index.d.ts:1975
Parameters
- name: string
- type: 6
- Optional options: string | CreateChannelOptions
Returns Promise<StoreChannel>
- Defined in node_modules/eris/index.d.ts:1976
Parameters
- name: string
- type: 13
- Optional options: string | CreateChannelOptions
Returns Promise<StageChannel>
- Defined in node_modules/eris/index.d.ts:1977
Parameters
- name: string
- Optional type: number
- Optional options: CreateChannelOptions
Returns Promise<unknown>
- Defined in node_modules/eris/index.d.ts:1979
deprecated

Parameters
- name: string
- type: 0
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<TextChannel>
- Defined in node_modules/eris/index.d.ts:1981
deprecated

Parameters
- name: string
- type: 2
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<VoiceChannel>
- Defined in node_modules/eris/index.d.ts:1983
deprecated

Parameters
- name: string
- type: 4
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<CategoryChannel>
- Defined in node_modules/eris/index.d.ts:1985
deprecated

Parameters
- name: string
- type: 5
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<NewsChannel>
- Defined in node_modules/eris/index.d.ts:1987
deprecated

Parameters
- name: string
- type: 6
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<StoreChannel>
- Defined in node_modules/eris/index.d.ts:1989
deprecated

Parameters
- name: string
- type: 13
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<StageChannel>
- Defined in node_modules/eris/index.d.ts:1991
deprecated

Parameters
- name: string
- Optional type: number
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<unknown>

createEmoji

createEmoji(options: { image: string; name: string; roles?: undefined | string[] }, reason?: string): Promise<Emoji>

- Defined in node_modules/eris/index.d.ts:1992
Parameters
- options: { image: string; name: string; roles?: undefined | string[] }
  - image: string
  - name: string
  - Optional roles?: undefined | string[]
- Optional reason: string
Returns Promise<Emoji>

createRole

createRole(options: Role | RoleOptions, reason?: string): Promise<Role>

- Defined in node_modules/eris/index.d.ts:1993
Parameters
- options: Role | RoleOptions
- Optional reason: string
Returns Promise<Role>

createTemplate

createTemplate(name: string, description?: null | string): Promise<GuildTemplate>

- Defined in node_modules/eris/index.d.ts:1994
Parameters
- name: string
- Optional description: null | string
Returns Promise<GuildTemplate>

delete

delete(): Promise<void>

- Defined in node_modules/eris/index.d.ts:1995
Returns Promise<void>

deleteDiscoverySubcategory

deleteDiscoverySubcategory(categoryID: string, reason?: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:1996
Parameters
- categoryID: string
- Optional reason: string
Returns Promise<void>

deleteEmoji

deleteEmoji(emojiID: string, reason?: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:1997
Parameters
- emojiID: string
- Optional reason: string
Returns Promise<void>

deleteIntegration

deleteIntegration(integrationID: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:1998
Parameters
- integrationID: string
Returns Promise<void>

deleteRole

deleteRole(roleID: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:1999
Parameters
- roleID: string
Returns Promise<void>

deleteTemplate

deleteTemplate(code: string): Promise<GuildTemplate>

- Defined in node_modules/eris/index.d.ts:2000
Parameters
- code: string
Returns Promise<GuildTemplate>

dynamicBannerURL

dynamicBannerURL(format?: "jpg" | "jpeg" | "png" | "webp" | "gif", size?: number): string

- Defined in node_modules/eris/index.d.ts:2001
Parameters
- Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"
- Optional size: number
Returns string

dynamicDiscoverySplashURL

dynamicDiscoverySplashURL(format?: "jpg" | "jpeg" | "png" | "webp" | "gif", size?: number): string

- Defined in node_modules/eris/index.d.ts:2002
Parameters
- Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"
- Optional size: number
Returns string

dynamicIconURL

dynamicIconURL(format?: "jpg" | "jpeg" | "png" | "webp" | "gif", size?: number): string

- Defined in node_modules/eris/index.d.ts:2003
Parameters
- Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"
- Optional size: number
Returns string

dynamicSplashURL

dynamicSplashURL(format?: "jpg" | "jpeg" | "png" | "webp" | "gif", size?: number): string

- Defined in node_modules/eris/index.d.ts:2004
Parameters
- Optional format: "jpg" | "jpeg" | "png" | "webp" | "gif"
- Optional size: number
Returns string

edit

edit(options: GuildOptions, reason?: string): Promise<Guild>

- Defined in node_modules/eris/index.d.ts:2005
Parameters
- options: GuildOptions
- Optional reason: string
Returns Promise<Guild>

editDiscovery

editDiscovery(options?: DiscoveryOptions): Promise<DiscoveryMetadata>

- Defined in node_modules/eris/index.d.ts:2006
Parameters
- Optional options: DiscoveryOptions
Returns Promise<DiscoveryMetadata>

editEmoji

editEmoji(emojiID: string, options: { name: string; roles?: undefined | string[] }, reason?: string): Promise<Emoji>

- Defined in node_modules/eris/index.d.ts:2007
Parameters
- emojiID: string
- options: { name: string; roles?: undefined | string[] }
  - name: string
  - Optional roles?: undefined | string[]
- Optional reason: string
Returns Promise<Emoji>

editIntegration

editIntegration(integrationID: string, options: IntegrationOptions): Promise<void>

- Defined in node_modules/eris/index.d.ts:2008
Parameters
- integrationID: string
- options: IntegrationOptions
Returns Promise<void>

editMember

editMember(memberID: string, options: MemberOptions, reason?: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:2009
Parameters
- memberID: string
- options: MemberOptions
- Optional reason: string
Returns Promise<void>

editNickname

editNickname(nick: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:2010
Parameters
- nick: string
Returns Promise<void>

editRole

editRole(roleID: string, options: RoleOptions): Promise<Role>

- Defined in node_modules/eris/index.d.ts:2011
Parameters
- roleID: string
- options: RoleOptions
Returns Promise<Role>

editTemplate

editTemplate(code: string, options: GuildTemplateOptions): Promise<GuildTemplate>

- Defined in node_modules/eris/index.d.ts:2012
Parameters
- code: string
- options: GuildTemplateOptions
Returns Promise<GuildTemplate>

editVanity

editVanity(code: null | string): Promise<GuildVanity>

- Defined in node_modules/eris/index.d.ts:2013
Parameters
- code: null | string
Returns Promise<GuildVanity>

editVoiceState

editVoiceState(options: VoiceStateOptions, userID?: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:2014
Parameters
- options: VoiceStateOptions
- Optional userID: string
Returns Promise<void>

editWelcomeScreen

editWelcomeScreen(options: WelcomeScreenOptions): Promise<WelcomeScreen>

- Defined in node_modules/eris/index.d.ts:2015
Parameters
- options: WelcomeScreenOptions
Returns Promise<WelcomeScreen>

editWidget

editWidget(options: Widget): Promise<Widget>

- Defined in node_modules/eris/index.d.ts:2016
Parameters
- options: Widget
Returns Promise<Widget>

fetchAllMembers

fetchAllMembers(timeout?: number): Promise<number>

- Defined in node_modules/eris/index.d.ts:2017
Parameters
- Optional timeout: number
Returns Promise<number>

fetchMembers

fetchMembers(options?: FetchMembersOptions): Promise<Member[]>

- Defined in node_modules/eris/index.d.ts:2018
Parameters
- Optional options: FetchMembersOptions
Returns Promise<Member[]>

getAuditLog

getAuditLog(options?: GetGuildAuditLogOptions): Promise<GuildAuditLog>

- Defined in node_modules/eris/index.d.ts:2019
Parameters
- Optional options: GetGuildAuditLogOptions
Returns Promise<GuildAuditLog>

getAuditLogs

getAuditLogs(limit?: number, before?: string, actionType?: number, userID?: string): Promise<GuildAuditLog>

- Defined in node_modules/eris/index.d.ts:2021
deprecated

Parameters
- Optional limit: number
- Optional before: string
- Optional actionType: number
- Optional userID: string
Returns Promise<GuildAuditLog>

getBan

getBan(userID: string): Promise<{ reason?: undefined | string; user: User }>

- Defined in node_modules/eris/index.d.ts:2022
Parameters
- userID: string
Returns Promise<{ reason?: undefined | string; user: User }>

getBans

getBans(): Promise<{ reason?: undefined | string; user: User }[]>

- Defined in node_modules/eris/index.d.ts:2023
Returns Promise<{ reason?: undefined | string; user: User }[]>

getDiscovery

getDiscovery(): Promise<DiscoveryMetadata>

- Defined in node_modules/eris/index.d.ts:2024
Returns Promise<DiscoveryMetadata>

getEmbed

getEmbed(): Promise<Widget>

- Defined in node_modules/eris/index.d.ts:2026
deprecated

Returns Promise<Widget>

getIntegrations

getIntegrations(options?: GetGuildIntegrationsOptions): Promise<GuildIntegration>

- Defined in node_modules/eris/index.d.ts:2027
Parameters
- Optional options: GetGuildIntegrationsOptions
Returns Promise<GuildIntegration>

getInvites

getInvites(): Promise<Invite<"withMetadata", InviteChannel>[]>

- Defined in node_modules/eris/index.d.ts:2028
Returns Promise<Invite<"withMetadata", InviteChannel>[]>

getPruneCount

getPruneCount(options?: GetPruneOptions): Promise<number>

- Defined in node_modules/eris/index.d.ts:2029
Parameters
- Optional options: GetPruneOptions
Returns Promise<number>

getRESTChannels

getRESTChannels(): Promise<AnyGuildChannel[]>

- Defined in node_modules/eris/index.d.ts:2030
Returns Promise<AnyGuildChannel[]>

getRESTEmoji

getRESTEmoji(emojiID: string): Promise<Emoji>

- Defined in node_modules/eris/index.d.ts:2031
Parameters
- emojiID: string
Returns Promise<Emoji>

getRESTEmojis

getRESTEmojis(): Promise<Emoji[]>

- Defined in node_modules/eris/index.d.ts:2032
Returns Promise<Emoji[]>

getRESTMember

getRESTMember(memberID: string): Promise<Member>

- Defined in node_modules/eris/index.d.ts:2033
Parameters
- memberID: string
Returns Promise<Member>

getRESTMembers

getRESTMembers(options?: GetRESTGuildMembersOptions): Promise<Member[]>
getRESTMembers(limit?: number, after?: string): Promise<Member[]>

- Defined in node_modules/eris/index.d.ts:2034
Parameters
- Optional options: GetRESTGuildMembersOptions
Returns Promise<Member[]>
- Defined in node_modules/eris/index.d.ts:2036
deprecated

Parameters
- Optional limit: number
- Optional after: string
Returns Promise<Member[]>

getRESTRoles

getRESTRoles(): Promise<Role[]>

- Defined in node_modules/eris/index.d.ts:2037
Returns Promise<Role[]>

getTemplates

getTemplates(): Promise<GuildTemplate[]>

- Defined in node_modules/eris/index.d.ts:2038
Returns Promise<GuildTemplate[]>

getVanity

getVanity(): Promise<GuildVanity>

- Defined in node_modules/eris/index.d.ts:2039
Returns Promise<GuildVanity>

getVoiceRegions

getVoiceRegions(): Promise<VoiceRegion[]>

- Defined in node_modules/eris/index.d.ts:2040
Returns Promise<VoiceRegion[]>

getWebhooks

getWebhooks(): Promise<Webhook[]>

- Defined in node_modules/eris/index.d.ts:2041
Returns Promise<Webhook[]>

getWelcomeScreen

getWelcomeScreen(): Promise<WelcomeScreen>

- Defined in node_modules/eris/index.d.ts:2042
Returns Promise<WelcomeScreen>

getWidget

getWidget(): Promise<Widget>

- Defined in node_modules/eris/index.d.ts:2043
Returns Promise<Widget>

inspect

inspect(): Guild

Inherited from Base.inspect
- Defined in node_modules/eris/index.d.ts:1364
Returns Guild

kickMember

kickMember(userID: string, reason?: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:2044
Parameters
- userID: string
- Optional reason: string
Returns Promise<void>

leave

leave(): Promise<void>

- Defined in node_modules/eris/index.d.ts:2045
Returns Promise<void>

leaveVoiceChannel

leaveVoiceChannel(): void

- Defined in node_modules/eris/index.d.ts:2046
Returns void

permissionsOf

permissionsOf(memberID: string | Member): Permission

- Defined in node_modules/eris/index.d.ts:2047
Parameters
- memberID: string | Member
Returns Permission

pruneMembers

pruneMembers(options?: PruneMemberOptions): Promise<number>

- Defined in node_modules/eris/index.d.ts:2048
Parameters
- Optional options: PruneMemberOptions
Returns Promise<number>

removeMemberRole

removeMemberRole(memberID: string, roleID: string, reason?: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:2049
Parameters
- memberID: string
- roleID: string
- Optional reason: string
Returns Promise<void>

searchMembers

searchMembers(query: string, limit?: number): Promise<Member[]>

- Defined in node_modules/eris/index.d.ts:2050
Parameters
- query: string
- Optional limit: number
Returns Promise<Member[]>

syncIntegration

syncIntegration(integrationID: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:2051
Parameters
- integrationID: string
Returns Promise<void>

syncTemplate

syncTemplate(code: string): Promise<GuildTemplate>

- Defined in node_modules/eris/index.d.ts:2052
Parameters
- code: string
Returns Promise<GuildTemplate>

toJSON

toJSON(props?: string[]): JSONCache

Inherited from Base.toJSON
- Defined in node_modules/eris/index.d.ts:1366
Parameters
- Optional props: string[]
Returns JSONCache

toString

toString(): string

Inherited from Base.toString
- Defined in node_modules/eris/index.d.ts:1365
Returns string

unbanMember

unbanMember(userID: string, reason?: string): Promise<void>

- Defined in node_modules/eris/index.d.ts:2053
Parameters
- userID: string
- Optional reason: string
Returns Promise<void>

Static getCreatedAt

getCreatedAt(id: string): number

Inherited from Base.getCreatedAt
- Defined in node_modules/eris/index.d.ts:1363
Parameters
- id: string
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: BaseData

client: Client

Returns Guild

Properties

afkChannelID

afkTimeout

applicationID

Optional approximateMemberCount

Optional approximatePresenceCount

Optional autoRemoved

banner

bannerURL

channels

createdAt

defaultNotifications

description

discoverySplash

discoverySplashURL

Optional emojiCount

emojis

explicitContentFilter

features

icon

iconURL

id

joinedAt

large

maxMembers

maxPresences

Optional maxVideoChannelUsers

memberCount

members

mfaLevel

name

nsfw

ownerID

preferredLocale

Optional premiumSubscriptionCount

premiumTier

Optional primaryCategory

Optional primaryCategoryID

publicUpdatesChannelID

region

roles

rulesChannelID

shard

splash

splashURL

systemChannelFlags

systemChannelID

unavailable

vanityURL

verificationLevel

voiceStates

Optional welcomeScreen

Optional widgetChannelID

Optional widgetEnabled

Methods

addDiscoverySubcategory

Parameters

categoryID: string

Optional reason: string

Returns Promise<DiscoverySubcategoryResponse>

addMemberRole

Parameters

memberID: string

roleID: string

Optional reason: string

Returns Promise<void>

banMember

Parameters

userID: string