BaseGuildChannel
Extends
ObjectToLower
<Omit
<APIGuildChannel
<ChannelType
>,"permission_overwrites"
>>.BaseChannel
<ChannelType
>
Constructors
new BaseGuildChannel(client, data)
Parameters
Parameter | Type |
---|---|
client | UsingClient |
data | APIGuildChannel <ChannelType > |
Returns
Inherited from
Source
seyfert/src/structures/channels.ts:168
Properties
Property | Modifier | Type | Inherited from |
---|---|---|---|
client | readonly | UsingClient | BaseChannel .client |
flags | public | undefined | ChannelFlags | ObjectToLower.flags |
guildId | public | undefined | string | ObjectToLower.guildId |
id | public | string | BaseChannel .id |
name | public | string | ObjectToLower.name |
nsfw | public | undefined | boolean | ObjectToLower.nsfw |
parentId | public | undefined | null | string | ObjectToLower.parentId |
permissionOverwrites | public | Object | - |
permissionOverwrites.fetch | public | () => ReturnCache <undefined | Object []> | - |
permissionOverwrites.values | public | () => Object [][] | - |
position | public | number | ObjectToLower.position |
type | public | ChannelType | BaseChannel .type |
Accessors
createdAt
createdAt gets the creation Date instace of the current object.
Returns
Date
Source
seyfert/src/structures/extra/DiscordBase.ts:27
createdTimestamp
Create a timestamp for the current object.
Returns
number
Source
seyfert/src/structures/extra/DiscordBase.ts:20
url
The URL to the channel
Returns
string
Source
seyfert/src/structures/channels.ts:194
Methods
delete()
Parameters
Parameter | Type |
---|---|
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
Source
seyfert/src/structures/channels.ts:66
edit()
Parameters
Parameter | Type |
---|---|
body | RESTPatchAPIChannelJSONBody |
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
Source
seyfert/src/structures/channels.ts:70
fetch()
Parameters
Parameter | Type | Default value |
---|---|---|
force | boolean | false |
Returns
Promise
<AllChannels
>
Inherited from
Source
seyfert/src/structures/channels.ts:62
guild()
Parameters
Parameter | Type | Default value |
---|---|---|
force | boolean | false |
Returns
Promise
<Guild
<"cached"
> | Guild
<"api"
>>
Source
seyfert/src/structures/channels.ts:190
is()
Type parameters
Type parameter |
---|
T extends keyof IChannelTypes [] |
Parameters
Parameter | Type |
---|---|
channelTypes | T |
Returns
this is IChannelTypes[T[number]]
Inherited from
Source
seyfert/src/structures/channels.ts:133
isCategory()
Returns
this is CategoryChannel
Inherited from
Source
seyfert/src/structures/channels.ts:113
isDM()
Returns
this is DMChannel
Inherited from
Source
seyfert/src/structures/channels.ts:89
isDirectory()
Returns
this is DirectoryChannel
Inherited from
Source
seyfert/src/structures/channels.ts:101
isForum()
Returns
this is ForumChannel
Inherited from
Source
seyfert/src/structures/channels.ts:93
isGuildTextable()
Returns
this is AllGuildTextableChannels
Inherited from
Source
seyfert/src/structures/channels.ts:125
isMedia()
Returns
this is MediaChannel
Inherited from
Source
seyfert/src/structures/channels.ts:85
isNews()
Returns
this is NewsChannel
Inherited from
Source
seyfert/src/structures/channels.ts:117
isStage()
Returns
this is StageChannel
Inherited from
Source
seyfert/src/structures/channels.ts:81
isTextGuild()
Returns
this is TextGuildChannel
Inherited from
Source
seyfert/src/structures/channels.ts:109
isTextable()
Returns
this is AllTextableChannels
Inherited from
Source
seyfert/src/structures/channels.ts:121
isThread()
Returns
this is ThreadChannel
Inherited from
Source
seyfert/src/structures/channels.ts:97
isThreadOnly()
Returns
this is MediaChannel | ForumChannel
Inherited from
Source
seyfert/src/structures/channels.ts:129
isVoice()
Returns
this is VoiceChannel
Inherited from
Source
seyfert/src/structures/channels.ts:105
memberPermissions()
Parameters
Parameter | Type | Default value |
---|---|---|
member | GuildMember | undefined |
checkAdmin | boolean | true |
Returns
Promise
<PermissionsBitField
>
Source
seyfert/src/structures/channels.ts:178
overwritesFor()
Parameters
Parameter | Type |
---|---|
member | GuildMember |
Returns
Promise
<Object
>
Member Type Value everyone
undefined
|Object
everyoneOverwrites member
undefined
|Object
memberOverwrites roles
Object
[]roleOverwrites
Source
seyfert/src/structures/channels.ts:186
rolePermissions()
Parameters
Parameter | Type | Default value |
---|---|---|
role | GuildRole | undefined |
checkAdmin | boolean | true |
Returns
Promise
<PermissionsBitField
>
Source
seyfert/src/structures/channels.ts:182
setName()
Parameters
Parameter | Type |
---|---|
name | string |
reason ? | string |
Returns
Promise
<AllChannels
>
Source
seyfert/src/structures/channels.ts:202
setParent()
Parameters
Parameter | Type |
---|---|
parent_id | null | string |
reason ? | string |
Returns
Promise
<AllChannels
>
Source
seyfert/src/structures/channels.ts:206
setPosition()
Parameters
Parameter | Type |
---|---|
position | number |
reason ? | string |
Returns
Promise
<AllChannels
>
Source
seyfert/src/structures/channels.ts:198
toString()
Returns
string
Inherited from
Source
seyfert/src/structures/channels.ts:77
__intent__()
__intent__(id)
Parameters
Parameter | Type |
---|---|
id | "@me" |
Returns
"DirectMessages"
Inherited from
Source
seyfert/src/structures/channels.ts:51
__intent__(id)
Parameters
Parameter | Type |
---|---|
id | string |
Returns
"DirectMessages"
| "Guilds"
Inherited from
Source
seyfert/src/structures/channels.ts:52
allMethods()
Parameters
Parameter | Type |
---|---|
ctx | Object |
ctx.client | UsingClient |
ctx.guildId | string |
Returns
Object
Member | Type | Value |
---|---|---|
create | (body : RESTPostAPIGuildChannelJSONBody ) => Promise <AllChannels > | - |
delete | (id : string , reason ?: string ) => Promise <AllChannels > | - |
edit | (id : string , body : RESTPatchAPIChannelJSONBody , reason ?: string ) => Promise <AllChannels > | - |
editPositions | (body : RESTPatchAPIGuildChannelPositionsJSONBody ) => Promise <never > | - |
fetch | (id : string , force : boolean ) => Promise <AllChannels > | - |
list | (force : boolean ) => Promise <AllChannels []> | - |