Documentation/detritus-client/Structures

StoreListingclass

Store Listing Structure Used for Store Channels ([ChannelGuildStore])

On this page

Overview
Constructor1
Properties16
Accessors3
Methods13

Store Listing Structure Used for Store Channels ([ChannelGuildStore])

import { Structures } from 'detritus-client';

Structures.StoreListing;

Hierarchy

StructureBaseStructureStoreListing

16 properties1 method15 inheritedsrc/structures/store.ts:48

Constructor

new StoreListing

src/structures/store.ts:67

new StoreListing(client: ShardClient, data?: BaseStructureData, isClone?: boolean)

Properties

assets

BaseCollection<string, StoreListingAsset>

boxArt?

StoreListingAsset

optional

carouselItems?

{ asset_id?: string; youtube_video_id?: string }[]

optional

client

ShardClient

readonly

Inherited from BaseStructure.client

description?

string

optional

entitlementBranchId?

string

optional

headerBackground?

StoreListingAsset

optional

headerLogoDarkTheme?

StoreListingAsset

optional

heroBackground?

StoreListingAsset

optional

heroVideo?

StoreListingAsset

optional

string

Default ''

previewVideo?

StoreListingAsset

optional

sku

Sku

summary

string

Default ''

tagline?

string

optional

thumbnail

StoreListingAsset

Accessors

isClone

boolean

get

Inherited from BaseStructure.isClone

shardId

number

get

Inherited from BaseStructure.shardId

url

string

get

Methods

_getFromSnake()

src/structures/basestructure.ts:138

_getFromSnake(key: string): any

Inherited from BaseStructure._getFromSnake

_setFromSnake()

src/structures/basestructure.ts:142

_setFromSnake(key: string, value: any): any

Inherited from BaseStructure._setFromSnake

[custom]()

src/structures/basestructure.ts:388

[custom](): object

Inherited from BaseStructure.[custom]

clone()

src/structures/basestructure.ts:431

clone(): this

Inherited from BaseStructure.clone

difference()

src/structures/basestructure.ts:146

difference(key: string, value: any): [boolean, any]

Inherited from BaseStructure.difference

differences()

src/structures/basestructure.ts:178

differences(data?: BaseStructureData): object | null

Inherited from BaseStructure.differences

differencesBetween()

src/structures/basestructure.ts:197

differencesBetween(structure: Structure): object | null

Inherited from BaseStructure.differencesBetween

hasDifference()

src/structures/basestructure.ts:218

hasDifference(key: string, value: any): boolean

Inherited from BaseStructure.hasDifference

hasDifferences()

src/structures/basestructure.ts:293

hasDifferences(data?: BaseStructureData): boolean

Inherited from BaseStructure.hasDifferences

hasDifferencesBetween()

src/structures/basestructure.ts:308

hasDifferencesBetween(structure: Structure): boolean

Inherited from BaseStructure.hasDifferencesBetween

merge()

src/structures/store.ts:80

merge(data?: BaseStructureData): void

Overrides BaseStructure.merge

mergeValue()

src/structures/basestructure.ts:351

mergeValue(key: string, value: any): void

Inherited from BaseStructure.mergeValue

toJSON()

src/structures/basestructure.ts:357

toJSON(): object

Inherited from BaseStructure.toJSON