Class HotelSuiteWebview

Represents the API for the Hotel Suite webview.

Hierarchy

HotelSuiteWebview

Implements

IHotelSuiteWebviewAPI

Index

Constructors

constructor

new HotelSuiteWebview(): HotelSuiteWebview
Returns HotelSuiteWebview
- Defined in index.ts:36

Properties

off

off: EventOverload = ...

Removes an event handler for the specified event type.

Param

The type of the event, which can be one of the following values: "key-write", "key-read", or "key-removed".

Param

The event handler function.

on

on: EventOverload = ...

Adds an event handler for the specified event type.

Param

The type of the event, which can be one of the following values: "key-write", "key-read", or "key-removed".

Param

The event handler function.

Methods

bluetoothAccess

bluetoothAccess(data): Number
Requests Bluetooth access.
Parameters
- data: IBluetoothAccess
  The Bluetooth access data.
Returns Number
The message ID (QueueId).

See
IBluetoothAccess
Implementation of IHotelSuiteWebviewAPI.bluetoothAccess
- Defined in index.ts:112

cancelOperation

cancelOperation(Id): Number
Cancels an ongoing operation identified by its ID.
Parameters
- Id: Number
  The message ID (QueueId).
Returns Number
A message sent to the webview indicating the cancellation of the operation.
- Defined in index.ts:171

checkIn

checkIn(data): Number
Checks in a guest.
Parameters
- data: ICheckIn
  The check-in data.
Returns Number
The message ID (QueueId).

See
ICheckIn
Implementation of IHotelSuiteWebviewAPI.checkIn
- Defined in index.ts:102

checkOut

checkOut(): Number
Checks out the guest.

Returns Number
The message ID (QueueId).
Implementation of IHotelSuiteWebviewAPI.checkOut
- Defined in index.ts:161

copyKey

copyKey(LockId, GuestName): Number
Copies a key for a guest.
Parameters
- LockId: Number
  The ID of the lock.
- GuestName: String
  The name of the guest.
Returns Number
The message ID (QueueId).
Implementation of IHotelSuiteWebviewAPI.copyKey
- Defined in index.ts:137

moveRoom

moveRoom(SourceLockId, TargetLockId): Number
Moves a guest from one room to another.
Parameters
- SourceLockId: Number
  The ID of the source room's lock.
- TargetLockId: Number
  The ID of the target room's lock.
Returns Number
The message ID (QueueId).
Implementation of IHotelSuiteWebviewAPI.moveRoom
- Defined in index.ts:150

quickCheckOut

quickCheckOut(LockIds): Number
Performs a quick check-out for multiple rooms.
Parameters
- LockIds: Number[]
  The IDs of the locks to be checked out.
Returns Number
The message ID (QueueId).
Implementation of IHotelSuiteWebviewAPI.quickCheckOut
- Defined in index.ts:183

requestFacilityData

requestFacilityData(): Number
Requests facility data from the webview.

Returns Number
A number indicating the success of the operation.

Remarks
This method triggers the webview to provide facility-data information.
Implementation of IHotelSuiteWebviewAPI.requestFacilityData
- Defined in index.ts:198

`Private` sendMessageToWebview

sendMessageToWebview(wrapper): Number
Private
Sends a message to the webview.
Parameters
- wrapper: MessageWrapper
  The message wrapper containing the action and message.
Returns Number
The message ID.
Implementation of IHotelSuiteWebviewAPI.sendMessageToWebview
- Defined in index.ts:88

updateReservation

updateReservation(data): Number
Updates reservation information.
Parameters
- data: ICheckIn
  The updated reservation data.
Returns Number
The message ID (QueueId).
Implementation of IHotelSuiteWebviewAPI.updateReservation
- Defined in index.ts:124

Class HotelSuiteWebview

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns HotelSuiteWebview

Properties

off

Param

Param

on

Param

Param

Methods

bluetoothAccess

Parameters

data: IBluetoothAccess

Returns Number

See

cancelOperation

Parameters

Id: Number

Returns Number

checkIn

Parameters

data: ICheckIn

Returns Number

See

checkOut

Returns Number

copyKey

Parameters

LockId: Number

GuestName: String

Returns Number

moveRoom

Parameters

SourceLockId: Number

TargetLockId: Number

Returns Number

quickCheckOut

Parameters

LockIds: Number[]

Returns Number

requestFacilityData

Returns Number

Remarks

Private sendMessageToWebview

Parameters

wrapper: MessageWrapper

Returns Number

updateReservation

Parameters

data: ICheckIn

Returns Number

Settings

Member Visibility

Theme

On This Page

`Private` sendMessageToWebview