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:1401
Parameters
- data: BaseData
- client: Client
Returns Guild

Properties

Optional afkChannelID

afkChannelID: undefined | string

afkTimeout

afkTimeout: number

Optional approximateMemberCount

approximateMemberCount: undefined | number

Optional approximatePresenceCount

approximatePresenceCount: undefined | number

Optional banner

banner: undefined | string

bannerURL

bannerURL: null | string

channels

channels: Collection<AnyGuildChannel>

createdAt

createdAt: number

defaultNotifications

defaultNotifications: number

Optional description

description: undefined | string

emojis

emojis: Emoji[]

explicitContentFilter

explicitContentFilter: number

features

features: string[]

Optional icon

icon: undefined | string

Optional iconURL

iconURL: undefined | 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: number

name

name: string

ownerID

ownerID: string

preferredLocale

preferredLocale: string

Optional premiumSubscriptionCount

premiumSubscriptionCount: undefined | number

premiumTier

premiumTier: number

publicUpdatesChannelID

publicUpdatesChannelID: string

region

region: string

roles

roles: Collection<Role>

rulesChannelID

rulesChannelID: string

shard

shard: Shard

Optional splash

splash: undefined | string

splashURL

splashURL: null | string

Optional systemChannelID

systemChannelID: undefined | string

unavailable

unavailable: boolean

Optional vanityURL

vanityURL: undefined | string

verificationLevel

verificationLevel: number

Optional widgetChannelID

widgetChannelID: undefined | null | string

Optional widgetEnabled

widgetEnabled: undefined | null | boolean

Methods

addMemberRole

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

- Defined in node_modules/eris/index.d.ts:1442
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:1445
Parameters
- userID: string
- Optional deleteMessageDays: number
- Optional reason: string
Returns Promise<void>

createChannel

createChannel(name: string): Promise<TextChannel>
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?: number, reason?: string, options?: string | CreateChannelOptions): Promise<unknown>
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?: number, options?: CreateChannelOptions): Promise<unknown>

- Defined in node_modules/eris/index.d.ts:1408
Parameters
- name: string
Returns Promise<TextChannel>
- Defined in node_modules/eris/index.d.ts:1409
Parameters
- name: string
- type: 0
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<TextChannel>
- Defined in node_modules/eris/index.d.ts:1410
Parameters
- name: string
- type: 2
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<VoiceChannel>
- Defined in node_modules/eris/index.d.ts:1411
Parameters
- name: string
- type: 4
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<CategoryChannel>
- Defined in node_modules/eris/index.d.ts:1412
Parameters
- name: string
- Optional type: number
- Optional reason: string
- Optional options: string | CreateChannelOptions
Returns Promise<unknown>
- Defined in node_modules/eris/index.d.ts:1413
Parameters
- name: string
- type: 0
- Optional options: CreateChannelOptions
Returns Promise<TextChannel>
- Defined in node_modules/eris/index.d.ts:1414
Parameters
- name: string
- type: 2
- Optional options: CreateChannelOptions
Returns Promise<VoiceChannel>
- Defined in node_modules/eris/index.d.ts:1415
Parameters
- name: string
- type: 4
- Optional options: CreateChannelOptions
Returns Promise<CategoryChannel>
- Defined in node_modules/eris/index.d.ts:1416
Parameters
- name: string
- Optional type: number
- Optional options: 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:1417
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: RoleOptions | Role, reason?: string): Promise<Role>

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

delete

delete(): Promise<void>

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

deleteEmoji

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

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

deleteIntegration

deleteIntegration(integrationID: string): Promise<void>

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

deleteRole

deleteRole(roleID: string): Promise<void>

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

dynamicBannerURL

dynamicBannerURL(format?: string, size?: number): string

- Defined in node_modules/eris/index.d.ts:1406
Parameters
- Optional format: string
- Optional size: number
Returns string

dynamicIconURL

dynamicIconURL(format?: string, size?: number): string

- Defined in node_modules/eris/index.d.ts:1405
Parameters
- Optional format: string
- Optional size: number
Returns string

dynamicSplashURL

dynamicSplashURL(format?: string, size?: number): string

- Defined in node_modules/eris/index.d.ts:1407
Parameters
- Optional format: string
- Optional size: number
Returns string

edit

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

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

editEmoji

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

- Defined in node_modules/eris/index.d.ts:1418
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:1436
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:1441
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:1452
Parameters
- nick: string
Returns Promise<void>

editRole

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

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

fetchAllMembers

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

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

fetchMembers

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

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

getAuditLogs

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

- Defined in node_modules/eris/index.d.ts:1434
Parameters
- Optional limit: number
- Optional before: string
- Optional actionType: number
Returns Promise<GuildAuditLog>

getBan

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

- Defined in node_modules/eris/index.d.ts:1451
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:1450
Returns Promise<{ reason?: undefined | string; user: User }[]>

getEmbed

getEmbed(): Promise<GuildEmbed>

- Defined in node_modules/eris/index.d.ts:1429
Returns Promise<GuildEmbed>

getIntegrations

getIntegrations(): Promise<GuildIntegration>

- Defined in node_modules/eris/index.d.ts:1435
Returns Promise<GuildIntegration>

getInvites

getInvites(): Promise<ChannelInvite[]>

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

getPruneCount

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

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

getRESTChannels

getRESTChannels(): Promise<AnyGuildChannel[]>

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

getRESTEmoji

getRESTEmoji(emojiID: string): Promise<Emoji>

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

getRESTEmojis

getRESTEmojis(): Promise<Emoji[]>

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

getRESTMember

getRESTMember(memberID: string): Promise<Member>

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

getRESTMembers

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

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

getRESTRoles

getRESTRoles(): Promise<Role[]>

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

getVanity

getVanity(): Promise<{ code?: undefined | string; uses?: undefined | number }>

- Defined in node_modules/eris/index.d.ts:1440
Returns Promise<{ code?: undefined | string; uses?: undefined | number }>

getVoiceRegions

getVoiceRegions(): Promise<VoiceRegion[]>

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

getWebhooks

getWebhooks(): Promise<Webhook[]>

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

inspect

inspect(): Guild

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

kickMember

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

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

leave

leave(): Promise<void>

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

leaveVoiceChannel

leaveVoiceChannel(): void

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

pruneMembers

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

- Defined in node_modules/eris/index.d.ts:1422
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:1443
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:1454
Parameters
- query: string
- Optional limit: number
Returns Promise<Member[]>

syncIntegration

syncIntegration(integrationID: string): Promise<void>

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

toJSON

toJSON(props?: string[]): JSONCache

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

unbanMember

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

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: BaseData

client: Client

Returns Guild

Properties

Optional afkChannelID

afkTimeout

Optional approximateMemberCount

Optional approximatePresenceCount

Optional banner

bannerURL

channels

createdAt

defaultNotifications

Optional description

emojis

explicitContentFilter

features

Optional icon

Optional iconURL

id

joinedAt

large

maxMembers

maxPresences

Optional maxVideoChannelUsers

memberCount

members

mfaLevel

name

ownerID

preferredLocale

Optional premiumSubscriptionCount

premiumTier

publicUpdatesChannelID

region

roles

rulesChannelID

shard

Optional splash

splashURL

Optional systemChannelID

unavailable

Optional vanityURL

verificationLevel

Optional widgetChannelID

Optional widgetEnabled

Methods

addMemberRole

Parameters

memberID: string

roleID: string

Optional reason: string

Returns Promise<void>

banMember

Parameters

userID: string

Optional deleteMessageDays: number

Optional reason: string

Returns Promise<void>

createChannel

Parameters

name: string

Returns Promise<TextChannel>

Parameters

name: string

type: 0

Optional reason: string

Optional options: string | CreateChannelOptions

Returns Promise<TextChannel>

Parameters

name: string

type: 2