Sticker
Extends
DiscordBase
.ObjectToLower
<Omit
<APISticker
,"user"
>>
Constructors
new Sticker(client, data)
1new Sticker(client: UsingClient, data: APISticker): Sticker
Parameters
Parameter | Type |
---|---|
client | UsingClient |
data | APISticker |
Returns
Inherited from
DiscordBase.constructor
Source
seyfert/src/structures/Sticker.ts:16
Properties
Property | Modifier | Type | Inherited from |
---|---|---|---|
asset | public | undefined | "" | ObjectToLower.asset |
available | public | undefined | boolean | ObjectToLower.available |
client | readonly | UsingClient | DiscordBase.client |
description | public | null | string | ObjectToLower.description |
formatType | public | StickerFormatType | ObjectToLower.formatType |
guildId | public | undefined | string | ObjectToLower.guildId |
id | public | string | DiscordBase.id |
name | public | string | ObjectToLower.name |
packId | public | undefined | string | ObjectToLower.packId |
sortValue | public | undefined | number | ObjectToLower.sortValue |
tags | public | string | ObjectToLower.tags |
type | public | StickerType | ObjectToLower.type |
user? | public | User | - |
Accessors
createdAt
1get createdAt(): Date
createdAt gets the creation Date instace of the current object.
Returns
Date
Source
seyfert/src/structures/extra/DiscordBase.ts:27
createdTimestamp
1get createdTimestamp(): number
Create a timestamp for the current object.
Returns
number
Source
seyfert/src/structures/extra/DiscordBase.ts:20
Methods
delete()
1delete(reason?: string): undefined | Promise<void>
Parameters
Parameter | Type |
---|---|
reason ? | string |
Returns
undefined
| Promise
<void
>
Source
seyfert/src/structures/Sticker.ts:38
edit()
1edit(body: RESTPatchAPIGuildStickerJSONBody, reason?: string): undefined | Promise<Sticker>
Parameters
Parameter | Type |
---|---|
body | RESTPatchAPIGuildStickerJSONBody |
reason ? | string |
Returns
undefined
| Promise
<Sticker
>
Source
seyfert/src/structures/Sticker.ts:28
fetch()
1fetch(force: boolean): undefined | Promise<Sticker>
Parameters
Parameter | Type | Default value |
---|---|---|
force | boolean | false |
Returns
undefined
| Promise
<Sticker
>
Source
seyfert/src/structures/Sticker.ts:33
guild()
1guild(force: boolean): undefined | Promise<Guild<"cached"> | Guild<"api">>
Parameters
Parameter | Type | Default value |
---|---|---|
force | boolean | false |
Returns
undefined
| Promise
<Guild
<"cached"
> | Guild
<"api"
>>
Source
seyfert/src/structures/Sticker.ts:23
methods()
1static methods(__namedParameters: Object): Object
Parameters
Parameter | Type |
---|---|
__namedParameters | Object |
__namedParameters.client | UsingClient |
__namedParameters.guildId | string |
Returns
Object
Member | Type | Value |
---|---|---|
create | (payload : CreateStickerBodyRequest , reason ?: string ) => Promise <Sticker > | - |
delete | (stickerId : string , reason ?: string ) => Promise <void > | - |
edit | (stickerId : string , body : RESTPatchAPIGuildStickerJSONBody , reason ?: string ) => Promise <Sticker > | - |
fetch | (stickerId : string , force : boolean ) => Promise <Sticker > | - |
list | () => Promise <Sticker []> | - |