Class HWallItem

Hierarchy

HWallItem

Index

Constructors

Accessors

id location ownerId ownerName secondsToExpiration state typeId usagePolicy

Methods

appendToPacket constructPacket parse

Constructors

constructor

new HWallItem(packet): HWallItem
Parameters
- packet: HPacket
Returns HWallItem
- Defined in lib/extension/parsers/hwallitem.d.ts:4

Accessors

id

get id(): number
Get id of wall item

Returns number
- Defined in lib/extension/parsers/hwallitem.d.ts:28
set id(val): void
Set id of wall item
Parameters
- val: number
  
  Id to be set
Returns void
- Defined in lib/extension/parsers/hwallitem.d.ts:76

location

get location(): string
Get location of wall item

Returns string
- Defined in lib/extension/parsers/hwallitem.d.ts:58
set location(val): void
Set location of wall item
Parameters
- val: string
  
  Location to be set
Returns void
- Defined in lib/extension/parsers/hwallitem.d.ts:94

ownerId

get ownerId(): number
Get owner id of wall item

Returns number
- Defined in lib/extension/parsers/hwallitem.d.ts:43
set ownerId(val): void
Set owner id of wall item
Parameters
- val: number
  
  Owner id to be set
Returns void
- Defined in lib/extension/parsers/hwallitem.d.ts:112

ownerName

get ownerName(): string
Get owner name of wall item

Returns string
- Defined in lib/extension/parsers/hwallitem.d.ts:48
set ownerName(val): void
Set owner name of wall item
Parameters
- val: string
  
  Owner name to be set
Returns void
- Defined in lib/extension/parsers/hwallitem.d.ts:70

secondsToExpiration

get secondsToExpiration(): number
Get seconds to expiration of wall item

Returns number
- Defined in lib/extension/parsers/hwallitem.d.ts:63
set secondsToExpiration(val): void
Set seconds to expiration of wall item
Parameters
- val: number
  
  Seconds to expiration to be set
Returns void
- Defined in lib/extension/parsers/hwallitem.d.ts:106

state

get state(): string
Get state of wall item

Returns string
- Defined in lib/extension/parsers/hwallitem.d.ts:53
set state(val): void
Set state of wall item
Parameters
- val: string
  
  State to be set
Returns void
- Defined in lib/extension/parsers/hwallitem.d.ts:88

typeId

get typeId(): number
Get type id of wall item

Returns number
- Defined in lib/extension/parsers/hwallitem.d.ts:33
set typeId(val): void
Set type id of wall item
Parameters
- val: number
  
  Type id to be set
Returns void
- Defined in lib/extension/parsers/hwallitem.d.ts:82

usagePolicy

get usagePolicy(): number
Get usage policy of wall item

Returns number
- Defined in lib/extension/parsers/hwallitem.d.ts:38
set usagePolicy(val): void
Set usage policy of wall item
Parameters
- val: number
  
  Usage policy to be set
Returns void
- Defined in lib/extension/parsers/hwallitem.d.ts:100

Methods

appendToPacket

appendToPacket(packet): void
Append wall item to packet
Parameters
- packet: HPacket
  
  Packet to append to
Returns void
- Defined in lib/extension/parsers/hwallitem.d.ts:10

`Static` constructPacket

constructPacket(wallItems, headerId): HPacket
Construct packet with header id containing all wall items
Parameters
- wallItems: HWallItem[]
  
  Wall items to add to packet
- headerId: number
  
  Header id for packet
Returns HPacket
- Defined in lib/extension/parsers/hwallitem.d.ts:23

`Static` parse

parse(packet): HWallItem[]
Parse all wall items from packet
Parameters
- packet: HPacket
  
  Packet to parse from
Returns HWallItem[]
- Defined in lib/extension/parsers/hwallitem.d.ts:16

Generated using TypeDoc