Class: Place

structures.Place

Hierarchy

• BasePlace

↳ Place

Table of contents

Constructors

• constructor

Properties

• client
• creatorId
• creatorName
• description
• id
• imageToken
• name
• playable
• price
• prohibited
• prohibitedReason
• universe
• url

Methods

• awardBadge
• getCompatibilities
• getGameServers
• getStatistics
• updatePlaceConfiguration

Constructors

constructor

+ new Place(data: PlaceOptions, client: default): Place

Parameters:

Name	Type
data	PlaceOptions
client	default

Returns: Place

Inherited from: BasePlace

Defined in: structures/Game.ts:237

Properties

client

• client: default

Inherited from: BasePlace.client

Defined in: structures/Game.ts:164

---

creatorId

• creatorId: number

Defined in: structures/Game.ts:231

---

creatorName

• creatorName: string

Defined in: structures/Game.ts:230

---

description

• description: string

Defined in: structures/Game.ts:228

---

id

• id: number

Inherited from: BasePlace.id

Defined in: structures/Game.ts:165

---

imageToken

• imageToken: string

Defined in: structures/Game.ts:237

---

name

• name: null | string

Inherited from: BasePlace.name

Defined in: structures/Game.ts:166

---

playable

• playable: boolean

Defined in: structures/Game.ts:232

---

price

• price: number

Defined in: structures/Game.ts:236

---

prohibited

• prohibited: boolean

Defined in: structures/Game.ts:234

---

prohibitedReason

• prohibitedReason: string

Defined in: structures/Game.ts:233

---

universe

• universe: PartialGameUniverse

Defined in: structures/Game.ts:235

---

url

• url: string

Defined in: structures/Game.ts:229

Methods

awardBadge

▸ awardBadge(userId: number, badgeId: number): Promise<boolean>

Parameters:

Name	Type
userId	number
badgeId	number

Returns: Promise<boolean>

Inherited from: BasePlace

Defined in: structures/Game.ts:194

---

getCompatibilities

▸ getCompatibilities(): Promise<GetPlaceCompatibilities>

Returns: Promise<GetPlaceCompatibilities>

Inherited from: BasePlace

Defined in: structures/Game.ts:174

---

getGameServers

▸ getGameServers(options: Pick<GetGameServersByTypeOptions, limit | cursor | sortOrder | serverType>): Promise<GetGameServersByType>

Parameters:

Name	Type
options	Pick<GetGameServersByTypeOptions, limit | cursor | sortOrder | serverType>

Returns: Promise<GetGameServersByType>

Inherited from: BasePlace

Defined in: structures/Game.ts:202

---

getStatistics

▸ getStatistics(options: Pick<GetPlaceStatisticsByTypeOptions, type | granularity | divisionType | startTime | endTime>): Promise<GetPlaceStatisticsByType>

Parameters:

Name	Type
options	Pick<GetPlaceStatisticsByTypeOptions, type | granularity | divisionType | startTime | endTime>

Returns: Promise<GetPlaceStatisticsByType>

Inherited from: BasePlace

Defined in: structures/Game.ts:187

---

updatePlaceConfiguration

▸ updatePlaceConfiguration(options: { description: string ; name: string }): Promise<UpdatePlaceConfiguration>

Parameters:

Name	Type
options	object
options.description	string
options.name	string

Returns: Promise<UpdatePlaceConfiguration>

Inherited from: BasePlace

Defined in: structures/Game.ts:180