TextBaseGuildChannel
Extends
ObjectToLower
<Omit
<APITextChannel
,"type"
|"permission_overwrites"
>>.MessagesMethods
.BaseGuildChannel
Constructors
new TextBaseGuildChannel(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 | BaseGuildChannel .client |
defaultAutoArchiveDuration | public | undefined | ThreadAutoArchiveDuration | ObjectToLower.defaultAutoArchiveDuration |
defaultThreadRateLimitPerUser | public | undefined | number | ObjectToLower.defaultThreadRateLimitPerUser |
flags | public | undefined | ChannelFlags | BaseGuildChannel .flags |
guildId | public | undefined | string | BaseGuildChannel .guildId |
id | public | string | BaseGuildChannel .id |
lastMessageId | public | undefined | null | string | ObjectToLower.lastMessageId |
lastPinTimestamp | public | undefined | null | string | ObjectToLower.lastPinTimestamp |
messages | public | Object | MessagesMethods .messages |
messages.crosspost | public | (messageId : string , reason ?: string ) => Promise <Message > | - |
messages.delete | public | (messageId : string , reason ?: string ) => Promise <void > | - |
messages.edit | public | (messageId : string , body : Omit <RESTPatchAPIChannelMessageJSONBody , "components" | "embeds" > & ResolverProps ) => Promise <Message > | - |
messages.fetch | public | (messageId : string ) => Promise <Message > | - |
messages.purge | public | (messages : string [], reason ?: string ) => Promise <undefined | void > | - |
messages.write | public | (body : Omit <RESTPostAPIChannelMessageJSONBody , "components" | "embeds" | "poll" > & SendResolverProps ) => Promise <Message > | - |
name | public | string | BaseGuildChannel .name |
nsfw | public | undefined | boolean | BaseGuildChannel .nsfw |
parentId | public | undefined | null | string | BaseGuildChannel .parentId |
permissionOverwrites | public | Object | BaseGuildChannel .permissionOverwrites |
permissionOverwrites.fetch | public | () => ReturnCache <undefined | Object []> | - |
permissionOverwrites.values | public | () => Object [][] | - |
pins | public | Object | MessagesMethods .pins |
pins.delete | public | (messageId : string , reason ?: string ) => Promise <never > | - |
pins.fetch | public | () => Promise <Message []> | - |
pins.set | public | (messageId : string , reason ?: string ) => Promise <never > | - |
position | public | number | BaseGuildChannel .position |
rateLimitPerUser | public | undefined | number | ObjectToLower.rateLimitPerUser |
reactions | public | Object | MessagesMethods .reactions |
reactions.add | public | (messageId : string , emoji : EmojiResolvable ) => Promise <void > | - |
reactions.delete | public | (messageId : string , emoji : EmojiResolvable , userId : string ) => Promise <void > | - |
reactions.fetch | public | (messageId : string , emoji : EmojiResolvable , query ?: RESTGetAPIChannelMessageReactionUsersQuery ) => Promise <User []> | - |
reactions.purge | public | (messageId : string , emoji ?: EmojiResolvable ) => Promise <void > | - |
topic | public | undefined | null | string | ObjectToLower.topic |
type | public | ChannelType | BaseGuildChannel .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"
>>
Inherited from
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
BaseGuildChannel
.isGuildTextable
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
>
Inherited from
BaseGuildChannel
.memberPermissions
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
Inherited from
BaseGuildChannel
.overwritesFor
Source
seyfert/src/structures/channels.ts:186
rolePermissions()
Parameters
Parameter | Type | Default value |
---|---|---|
role | GuildRole | undefined |
checkAdmin | boolean | true |
Returns
Promise
<PermissionsBitField
>
Inherited from
BaseGuildChannel
.rolePermissions
Source
seyfert/src/structures/channels.ts:182
setName()
Parameters
Parameter | Type |
---|---|
name | string |
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
Source
seyfert/src/structures/channels.ts:202
setParent()
Parameters
Parameter | Type |
---|---|
parent_id | null | string |
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
Source
seyfert/src/structures/channels.ts:206
setPosition()
Parameters
Parameter | Type |
---|---|
position | number |
reason ? | string |
Returns
Promise
<AllChannels
>
Inherited from
Source
seyfert/src/structures/channels.ts:198
toString()
Returns
string
Inherited from
Source
seyfert/src/structures/channels.ts:77
typing()
Returns
Promise
<void
>
Inherited from
Source
seyfert/src/structures/channels.ts:213
__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 []> | - |