Classes
Members
Methods
# async cancelBooking(booking) → {Promise}
Cancel a booking.
Parameters:
| Name | Type | Description |
|---|---|---|
booking |
MPBooking |
Promise
# async getBookableLocations(query) → {Array.<string>}
Get locations that can be booked.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
query |
Object | ||
startTime |
Date | The earlist begining of the booking interval in UTC | |
endTime |
Date | The latest end of the booking interval in UTC | |
venue |
string |
<optional> |
(Optional) The Name of the venue to limit the search to |
building |
string |
<optional> |
(Optional) The id of the building to limit the search to |
floorIndex |
integer |
<optional> |
(Optional) The index of the floor to limit the search to |
category |
string |
<optional> |
(Optional) The key of the Category to limit the search to |
locationType |
string |
<optional> |
(Optional) The AdministrativeId of the location type to limit the search to |
Location ID's
Array.<string>
# async getBookingsUsingQuery(query) → {Array.<MPBooking>}
Get bookings. The given query must include either location or ownerId.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
query |
Object | ||
location |
Location |
<optional> |
A MapsIndoors location to get bookings for. |
ownerId |
string |
<optional> |
The id of the user to get bookings for. |
startTime |
Date | The earlist begining of the booking interval in UTC | |
endTime |
Date | The latest end of the booking interval in UTC |
Array.<MPBooking>
# MPBooking(booking) → {MPBooking}
Create a MPBooking object.
MPBooking represents an existing booking object or a booking to be made. bookingId will be non-null for an existing booking, and null for a booking to be made.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
booking |
Object | ||
bookingId |
string |
<optional> |
|
locationId |
string | ||
startTime |
string | Date | ||
endTime |
string | Date | ||
participants |
Array.<string> |
<optional> |
|
title |
string |
<optional> |
|
description |
string |
<optional> |
|
managed |
boolean |
<optional> |
MPBooking
# async performBooking(booking) → {MPBooking}
Perform a booking
Parameters:
| Name | Type | Description |
|---|---|---|
booking |
MPBooking |
MPBooking
# setAuthenticationConfig(confignullable)
Sets the authentication configuration for calling the booking api.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
config |
BookingAuthenticationConfig |
<nullable> |